org.jamplate.impl.instruction

Class BranchExecInstr0Instr1Instr2

java.lang.Object

org.jamplate.impl.instruction.BranchExecInstr0Instr1Instr2

All Implemented Interfaces:

java.io.Serializable, Instruction

public class BranchExecInstr0Instr1Instr2
extends java.lang.Object
implements Instruction

BRANCH( EXEC( INSTR0 ) , INSTR1 , INSTR2 )

An instruction that execute a pre-specified instruction A then if the results was not false* then executes a pre-specified instruction B otherwise executes a pre-specified instruction C.

Since:

0.2.0 ~2021.05.24

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull Instruction	instruction0 The condition instruction.
protected @NotNull Instruction	instruction1 The instruction to be executed when the condition passes.
protected @NotNull Instruction	instruction2 The instruction to be executed when the condition fails.
protected @Nullable Tree	tree The tree this instruction was declared at.

Constructor Summary

Constructors

Constructor and Description
BranchExecInstr0Instr1Instr2(@NotNull Instruction instruction0, @NotNull Instruction instruction1) Construct a new instruction that executes the given instruction0 and executes the given instruction1 when the condition succeed.
BranchExecInstr0Instr1Instr2(@NotNull Instruction instruction0, @NotNull Instruction instruction1, @NotNull Instruction instruction2) Construct a new instruction that executes the given instruction0 and executes the given instruction1 when the condition succeed and execute the given instruction2 when the condition fails.
BranchExecInstr0Instr1Instr2(@NotNull Tree tree, @NotNull Instruction instruction0, @NotNull Instruction instruction1) Construct a new instruction that executes the given instruction0 and executes the given instruction1 when the condition succeed.
BranchExecInstr0Instr1Instr2(@NotNull Tree tree, @NotNull Instruction instruction0, @NotNull Instruction instruction1, @NotNull Instruction instruction2) Construct a new instruction that executes the given instruction0 and executes the given instruction1 when the condition succeed and execute the given instruction2 when the condition fails.

Method Summary

Modifier and Type	Method and Description
void	exec(@NotNull Environment environment, @NotNull Memory memory) Execute this instruction with the given environment and memory.
@Nullable Tree	getTree() Return the tree from where this instruction was declared.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jamplate.model.Instruction

create, create

Field Detail

instruction0

@NotNull
protected final @NotNull Instruction instruction0

The condition instruction.

Since:

0.2.0 ~2021.05.24

instruction1

@NotNull
protected final @NotNull Instruction instruction1

The instruction to be executed when the condition passes.

Since:

0.2.0 ~2021.05.24

instruction2

@NotNull
protected final @NotNull Instruction instruction2

The instruction to be executed when the condition fails.

Since:

0.2.0 ~2021.05.24

tree

@Nullable
protected final @Nullable Tree tree

The tree this instruction was declared at.

Since:

0.2.0 ~2021.05.23

Constructor Detail

BranchExecInstr0Instr1Instr2

public BranchExecInstr0Instr1Instr2(@NotNull
                                    @NotNull Instruction instruction0,
                                    @NotNull
                                    @NotNull Instruction instruction1)

Construct a new instruction that executes the given instruction0 and executes the given instruction1 when the condition succeed.

Parameters:

instruction0 - the condition instruction.

instruction1 - the instruction to be executed when the condition succeed.

Throws:

java.lang.NullPointerException - if the given instruction0 or instruction1 is null.

Since:

0.2.0 ~2021.05.24

BranchExecInstr0Instr1Instr2

public BranchExecInstr0Instr1Instr2(@NotNull
                                    @NotNull Instruction instruction0,
                                    @NotNull
                                    @NotNull Instruction instruction1,
                                    @NotNull
                                    @NotNull Instruction instruction2)

Construct a new instruction that executes the given instruction0 and executes the given instruction1 when the condition succeed and execute the given instruction2 when the condition fails.

Parameters:

instruction0 - the condition instruction.

instruction1 - the instruction to be executed when the condition succeed.

instruction2 - the instruction to be executed when the condition fails.

Throws:

java.lang.NullPointerException - if the given instruction0 or instruction1 or instruction2 is null.

Since:

0.2.0 ~2021.05.24

BranchExecInstr0Instr1Instr2

public BranchExecInstr0Instr1Instr2(@NotNull
                                    @NotNull Tree tree,
                                    @NotNull
                                    @NotNull Instruction instruction0,
                                    @NotNull
                                    @NotNull Instruction instruction1)

Construct a new instruction that executes the given instruction0 and executes the given instruction1 when the condition succeed.

Parameters:

tree - the tree from where this instruction was declared.

instruction0 - the condition instruction.

instruction1 - the instruction to be executed when the condition succeed.

Throws:

java.lang.NullPointerException - if the given instruction0 or instruction1 is null.

Since:

0.2.0 ~2021.05.24

BranchExecInstr0Instr1Instr2

public BranchExecInstr0Instr1Instr2(@NotNull
                                    @NotNull Tree tree,
                                    @NotNull
                                    @NotNull Instruction instruction0,
                                    @NotNull
                                    @NotNull Instruction instruction1,
                                    @NotNull
                                    @NotNull Instruction instruction2)

Construct a new instruction that executes the given instruction0 and executes the given instruction1 when the condition succeed and execute the given instruction2 when the condition fails.

Parameters:

tree - the tree from where this instruction was declared.

instruction0 - the condition instruction.

instruction1 - the instruction to be executed when the condition succeed.

instruction2 - the instruction to be executed when the condition fails.

Throws:

java.lang.NullPointerException - if the given instruction0 or instruction1 or instruction2 is null.

Since:

0.2.0 ~2021.05.24

Method Detail

exec

public void exec(@NotNull
                 @NotNull Environment environment,
                 @NotNull
                 @NotNull Memory memory)

Description copied from interface: Instruction

Execute this instruction with the given environment and memory.

Specified by:

exec in interface Instruction

Parameters:

environment - the environment this instruction is executed in.

memory - the memory holding the variables for this instruction to depend on.

getTree

@Nullable
public @Nullable Tree getTree()

Description copied from interface: Instruction

Return the tree from where this instruction was declared. (optional)

Specified by:

getTree in interface Instruction

Returns:

the tree of this instruction.