org.jamplate.model

Interface Instruction

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AllocAddrConst, AllocAddrExecInstr, BranchExecInstr0Instr1Instr2, ConsoleExecInstr, CpedAddrXinstr, ExecImportExecInstr, FallocAddrConst, FpedAddrExecInstrXinstr, FreeAddr, Idle, IpedXinstr, IterXinstr, PrintExecInstr, PushAddExecInstr0ExecInstr1, PushCmpExecInstr0ExecInstr1, PushConst, PushDefAddr, PushDivExecInstr0ExecInstr1, PushEqlExecInstr0ExecInstr1, PushEvalAddr, PushGetAddrExecInstr, PushLndExecInstr0ExecInstr1, PushLorExecInstr0ExecInstr1, PushModExecInstr0ExecInstr1, PushMulExecInstr0ExecInstr1, PushNdefAddr, PushNegExecInstr, PushSubExecInstr0ExecInstr1, PutAddrExecInstr0ExecInstr1, RepllocAddrExecInstr, RepreeAddr, ReprntConst, SerrExecInstr, SoutExecInstr, SpreadExecInstr, WpedInstrXinstr

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Instruction
extends java.io.Serializable

An instruction is a function that executes depending on the state of the environment and memory given to it but does not have a state itself.

Since:

0.2.0 ~2021.05.21

Version:

0.2.0

Author:

LSafer

Method Summary

Modifier and Type	Method and Description
static @NotNull Instruction	create(@NotNull Instruction instruction) Wrap the given instruction with another instruction delegates to the given instruction when executed.
static @NotNull Instruction	create(@NotNull Tree tree, @NotNull Instruction instruction) Wrap the given instruction with another instruction delegates to the given instruction when executed and return the given tree when its getTree() is called.
void	exec(@NotNull Environment environment, @NotNull Memory memory) Execute this instruction with the given environment and memory.
default @Nullable Tree	getTree() Return the tree from where this instruction was declared.

Method Detail

create

@NotNull
 @Contract(value="_->new",
          pure=true)
static @NotNull Instruction create(@NotNull
                                                                                               @NotNull Instruction instruction)

Wrap the given instruction with another instruction delegates to the given instruction when executed.

Parameters:

instruction - the instruction to be delegated to by the returned instruction.

Returns:

a new instruction that delegates to the given instruction.

Throws:

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

Since:

0.2.0 ~2021.05.23

create

@NotNull
 @Contract(value="_,_->new",
          pure=true)
static @NotNull Instruction create(@NotNull
                                                                                                 @NotNull Tree tree,
                                                                                                 @NotNull
                                                                                                 @NotNull Instruction instruction)

Wrap the given instruction with another instruction delegates to the given instruction when executed and return the given tree when its getTree() is called.

Parameters:

tree - the tree to be returned by the returned instruction.

instruction - the instruction to be delegated to by the returned instruction.

Returns:

a new instruction that delegates to the given instruction and has the given tree.

Throws:

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

Since:

0.2.0 ~2021.05.23

getTree

@Nullable
 @Contract(pure=true)
default @Nullable Tree getTree()

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

Returns:

the tree of this instruction.

Since:

0.2.0 ~2021.05.23

exec

@Contract(mutates="param1,param2")
void exec(@NotNull
                                              @NotNull Environment environment,
                                              @NotNull
                                              @NotNull Memory memory)

Execute this instruction with the given environment and memory.

Parameters:

environment - the environment this instruction is executed in.

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

Throws:

java.lang.NullPointerException - if the given environment or memory is null.

ExecutionException - if this instruction failed to be executed.

Since:

0.2.0 ~2021.05.21