org.jamplate.impl.instruction

Class PushConst

java.lang.Object

org.jamplate.impl.instruction.PushConst

All Implemented Interfaces:

java.io.Serializable, Instruction

public class PushConst
extends java.lang.Object
implements Instruction

PUSH( CONST )

An instruction that pushes a pre-specified constant to the stack.

Since:

0.2.0 ~2021.05.23

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull java.lang.String	constant The constant to be pushed.
protected @Nullable Tree	tree The tree of this instruction.

Constructor Summary

Constructors

Constructor and Description
PushConst(@NotNull java.lang.String constant) Construct a new instruction that pushes the given constant to the stack.
PushConst(@NotNull Tree tree) Construct a new instruction that pushes the content of the given tree to the stack.
PushConst(@NotNull Tree tree, @NotNull java.lang.String constant) Construct a new instruction that pushes the given constant to the stack.

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

constant

@NotNull
protected final @NotNull java.lang.String constant

The constant to be pushed.

Since:

0.2.0 ~2021.05.23

tree

@Nullable
protected final @Nullable Tree tree

The tree of this instruction.

Since:

0.2.0 ~2021.05.23

Constructor Detail

PushConst

public PushConst(@NotNull
                 @NotNull Tree tree)

Construct a new instruction that pushes the content of the given tree to the stack.

Parameters:

tree - the tree of the constructed instruction.

Throws:

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

Since:

0.2.0 ~2021.05.23

PushConst

public PushConst(@NotNull
                 @NotNull java.lang.String constant)

Construct a new instruction that pushes the given constant to the stack.

Parameters:

constant - the constant to be pushed.

Throws:

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

Since:

0.2.0 ~2021.05.23

PushConst

public PushConst(@NotNull
                 @NotNull Tree tree,
                 @NotNull
                 @NotNull java.lang.String constant)

Construct a new instruction that pushes the given constant to the stack.

Parameters:

tree - the tree of the constructed instruction.

constant - the constant to be pushed.

Throws:

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

Since:

0.2.0 ~2021.05.23

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.