org.jamplate.model

Interface Compilation

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CompilationImpl

public interface Compilation
extends java.io.Serializable

A compilation is a structure holding the variables for a single compilation unit (like a file).
The implementing class must support serialization.

Since:

0.2.0 ~2021.04.28

Version:

0.2.0

Author:

LSafer

Method Summary

Modifier and Type	Method and Description
@NotNull Environment	getEnvironment() Return the environment this compilation is on.
@Nullable Instruction	getInstruction() Return the instruction set for this compilation.
@NotNull java.util.Map<java.lang.String,java.lang.Object>	getMeta() Returns the meta-data map of this compilation.
@NotNull Tree	getRootTree() Return the root tree of this compilation.
void	setInstruction(@NotNull Instruction instruction) Set the intrusion of the compilation to be the given instruction.

Method Detail

getEnvironment

@NotNull
 @Contract(pure=true)
@NotNull Environment getEnvironment()

Return the environment this compilation is on.

Returns:

the environment of this compilation.

Since:

0.2.0 ~2021.05.16

getInstruction

@Nullable
 @Contract(pure=true)
@Nullable Instruction getInstruction()

Return the instruction set for this compilation.

Returns:

the instruction of this compilation.

Since:

0.2.0 ~2021.05.23

getMeta

@NotNull
 @Contract(pure=true)
@NotNull java.util.Map<java.lang.String,java.lang.Object> getMeta()

Returns the meta-data map of this compilation.
By default, the returned map will be a modifiable checked map. Unless, the class of this said otherwise.

Returns:

the meta-data map of this.

Since:

0.2.0 ~2021.05.21

getRootTree

@NotNull
 @Contract(pure=true)
@NotNull Tree getRootTree()

Return the root tree of this compilation.

Returns:

the root tree.

Since:

0.2.0 ~2021.05.16

setInstruction

@Contract(mutates="this")
void setInstruction(@NotNull
                                               @NotNull Instruction instruction)

Set the intrusion of the compilation to be the given instruction. It is expected pass an instruction resultant from compiling this compilation with a real compiler. But, there is no additional checks to validate that. So, be nice and follow the rules. Please?

Parameters:

instruction - the instruction to be set for this compilation.

Throws:

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

Since:

0.2.0 ~2021.05.23