org.jamplate.impl.model

Class CompilationImpl

java.lang.Object

org.jamplate.impl.model.CompilationImpl

All Implemented Interfaces:

java.io.Serializable, Compilation

public class CompilationImpl
extends java.lang.Object
implements Compilation

A basic compilation implementation with no special features.

Since:

0.2.0 ~2021.05.17

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull Environment	environment The environment this compilation is from.
protected @Nullable Instruction	instruction The instruction of this compilation.
protected @NotNull java.util.Map<java.lang.String,java.lang.Object>	meta The additional meta-data of this compilation.
protected @NotNull Tree	root The root tree of this compilation.

Constructor Summary

Constructors

Constructor and Description
CompilationImpl(@NotNull Environment environment, @NotNull Tree root) Construct a new compilation with the given root tree to be its root tree.

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.

Methods inherited from class java.lang.Object

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

Field Detail

environment

@NotNull
protected final @NotNull Environment environment

The environment this compilation is from.

Since:

0.2.0 ~2021.05.18

meta

@NotNull
protected final @NotNull java.util.Map<java.lang.String,java.lang.Object> meta

The additional meta-data of this compilation.

Since:

0.2.0 ~2021.05.21

root

@NotNull
protected final @NotNull Tree root

The root tree of this compilation.

Since:

0.2.0 ~2021.05.18

instruction

@Nullable
protected @Nullable Instruction instruction

The instruction of this compilation. This is the results of compiling this compilation.

Since:

0.2.0 ~2021.05.23

Constructor Detail

CompilationImpl

public CompilationImpl(@NotNull
                       @NotNull Environment environment,
                       @NotNull
                       @NotNull Tree root)

Construct a new compilation with the given root tree to be its root tree.

Parameters:

environment - the environment for the constructed compilation.

root - the root tree for the constructed compilation.

Throws:

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

Since:

0.2.0 ~2021.05.18

Method Detail

getEnvironment

@NotNull
public @NotNull Environment getEnvironment()

Description copied from interface: Compilation

Return the environment this compilation is on.

Specified by:

getEnvironment in interface Compilation

Returns:

the environment of this compilation.

getInstruction

@Nullable
public @Nullable Instruction getInstruction()

Description copied from interface: Compilation

Return the instruction set for this compilation.

Specified by:

getInstruction in interface Compilation

Returns:

the instruction of this compilation.

getMeta

@NotNull
public @NotNull java.util.Map<java.lang.String,java.lang.Object> getMeta()

Description copied from interface: Compilation

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.

Specified by:

getMeta in interface Compilation

Returns:

the meta-data map of this.

getRootTree

@NotNull
public @NotNull Tree getRootTree()

Description copied from interface: Compilation

Return the root tree of this compilation.

Specified by:

getRootTree in interface Compilation

Returns:

the root tree.

setInstruction

public void setInstruction(@NotNull
                           @NotNull Instruction instruction)

Description copied from interface: Compilation

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?

Specified by:

setInstruction in interface Compilation

Parameters:

instruction - the instruction to be set for this compilation.