org.jamplate.impl.instruction

Class IterXinstr

java.lang.Object

org.jamplate.impl.instruction.IterXinstr

All Implemented Interfaces:

java.io.Serializable, Instruction

public class IterXinstr
extends java.lang.Object
implements Instruction

ITER( XINSTR )

An instruction that ITER a pre-specified array of instructions.

Since:

0.2.0 ~2021.05.31

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull java.util.List<Instruction>	instructions The instructions to be executed.
protected @Nullable Tree	tree The tree from where this instruction was declared.

Constructor Summary

Constructors

Constructor and Description
IterXinstr(Instruction... instructions) Construct a new instruction that executes the given instructions in order in ITER style.
IterXinstr(@NotNull java.util.List<Instruction> instructions) Construct a new instruction that executes the given instructions in order in a ITER style.
IterXinstr(@NotNull Tree tree, Instruction... instructions) Construct a new instruction that executes the given instructions in order in a ITER style.
IterXinstr(@NotNull Tree tree, @NotNull java.util.List<Instruction> instructions) Construct a new instruction that executes the given instructions in order in a ITER style.

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

instructions

@NotNull
protected final @NotNull java.util.List<Instruction> instructions

The instructions to be executed.

Since:

0.2.0 ~2021.05.31

tree

@Nullable
protected final @Nullable Tree tree

The tree from where this instruction was declared.

Since:

0.2.0 ~2021.05.31

Constructor Detail

IterXinstr

public IterXinstr(@Nullable
                  Instruction... instructions)

Construct a new instruction that executes the given instructions in order in ITER style.
Null instructions in the array will be ignored.

Parameters:

instructions - the instructions to be executed.

Throws:

java.lang.NullPointerException - if the given instructions is null.

Since:

0.2.0 ~2021.05.31

IterXinstr

public IterXinstr(@NotNull
                  @NotNull java.util.List<Instruction> instructions)

Construct a new instruction that executes the given instructions in order in a ITER style.
Null instructions in the list will be ignored.

Parameters:

instructions - the instructions to be executed.

Throws:

java.lang.NullPointerException - if the given instructions is null.

Since:

0.2.0 ~2021.05.31

IterXinstr

public IterXinstr(@NotNull
                  @NotNull Tree tree,
                  @Nullable
                  Instruction... instructions)

Construct a new instruction that executes the given instructions in order in a ITER style.
Null instructions in the array will be ignored.

Parameters:

tree - the tree from where this instruction was declared.

instructions - the instructions to be executed.

Throws:

java.lang.NullPointerException - if the given tree or instructions is null.

Since:

0.2.0 ~2021.05.31

IterXinstr

public IterXinstr(@NotNull
                  @NotNull Tree tree,
                  @NotNull
                  @NotNull java.util.List<Instruction> instructions)

Construct a new instruction that executes the given instructions in order in a ITER style.
Null instructions in the list will be ignored.

Parameters:

tree - the tree from where this instruction was declared.

instructions - the instructions to be executed.

Throws:

java.lang.NullPointerException - if the given tree or instructions is null.

Since:

0.2.0 ~2021.05.31

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.