org.jamplate.model

Interface Environment

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

EnvironmentImpl

public interface Environment
extends java.io.Serializable

The environment is a unit holding all the data, managers and variables about a single process.
The subclasses must support serialization.

Since:

0.2.0 ~2021.05.16

Version:

0.2.0

Author:

LSafer

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.Set<Compilation>	compilationSet() Return a set view containing the compilations in this environment.
@Nullable Compilation	getCompilation(@NotNull Document document) Get the compilation set to this environment with the given document or return null if no such compilation exist in this environment.
@Nullable Compilation	getCompilation(@NotNull java.lang.String name) Get the compilation registered in this environment with the document qualified with the given name or return null if no such compilation has been set in this environment.
@NotNull Diagnostic	getDiagnostic() Return the diagnostic manager in this environment.
@NotNull java.util.Map<java.lang.String,java.lang.Object>	getMeta() Returns the meta-data map of this environment.
@NotNull Compilation	optCompilation(@NotNull Document document) Return the compilation set to this environment with the given document or create a new compilation for the given document, add it to this environment and return it.
void	setCompilation(@NotNull Document document, @NotNull Compilation compilation) Associate the given compilation to the given document in this environment.

Method Detail

compilationSet

@NotNull
 @Contract(pure=true)
@NotNull java.util.Set<Compilation> compilationSet()

Return a set view containing the compilations in this environment.

Returns:

a view of the compilations in this.

Since:

0.2.0 ~2021.05.23

getCompilation

@Nullable
 @Contract(pure=true)
@Nullable Compilation getCompilation(@NotNull
                                                                       @NotNull Document document)

Get the compilation set to this environment with the given document or return null if no such compilation exist in this environment.

Parameters:

document - the document of the compilation to be returned.

Returns:

the compilation with the given document in this environment. Or null if no such compilation exist.

Throws:

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

Since:

0.2.0 ~2021.05.21

getCompilation

@Nullable
 @Contract(pure=true)
@Nullable Compilation getCompilation(@NotNull
                                                                       @NotNull java.lang.String name)

Get the compilation registered in this environment with the document qualified with the given name or return null if no such compilation has been set in this environment.

Parameters:

name - the qualification name of the document of the compilation to be returned.

Returns:

the compilation with the given name set to this environment. Or null if no such compilation exist.

Throws:

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

Since:

0.2.0 ~2021.05.21

getDiagnostic

@NotNull
 @Contract(pure=true)
@NotNull Diagnostic getDiagnostic()

Return the diagnostic manager in this environment.

Returns:

the diagnostic manager.

Since:

0.2.0 ~2021.05.17

getMeta

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

Returns the meta-data map of this environment.
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

optCompilation

@NotNull
 @Contract(mutates="this")
@NotNull Compilation optCompilation(@NotNull
                                                                          @NotNull Document document)

Return the compilation set to this environment with the given document or create a new compilation for the given document, add it to this environment and return it.

Parameters:

document - the document to get a compilation for.

Returns:

the compilation with the given document in this environment or a newly created, then added compilation for the given document.

Throws:

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

Since:

0.2.0 ~2021.05.23

setCompilation

@Contract(mutates="this")
void setCompilation(@NotNull
                                               @NotNull Document document,
                                               @NotNull
                                               @NotNull Compilation compilation)

Associate the given compilation to the given document in this environment.

Parameters:

document - the document to be associated to the given compilation.

compilation - the compilation.

Throws:

java.lang.NullPointerException - if the given document or compilation is null.

Since:

0.2.0 ~2021.05.19