org.jamplate.impl.model

Class EnvironmentImpl

java.lang.Object

org.jamplate.impl.model.EnvironmentImpl

All Implemented Interfaces:

java.io.Serializable, Environment

public class EnvironmentImpl
extends java.lang.Object
implements Environment

A basic implementation of the interface Environment.

Since:

0.2.0 ~2021.05.19

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull java.util.Map<Document,Compilation>	compilations The compilations in this environment.
protected @Nullable @UnmodifiableView java.util.Set<Compilation>	compilationSet A set of the compilations in this environment.
protected @NotNull Diagnostic	diagnostic The diagnostic manager in this enlivenment.
protected @NotNull java.util.Map<java.lang.String,java.lang.Object>	meta The additional meta-data of this sketch.

Constructor Summary

Constructors

Constructor and Description
EnvironmentImpl()

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.

Methods inherited from class java.lang.Object

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

Field Detail

compilations

@NotNull
protected final @NotNull java.util.Map<Document,Compilation> compilations

The compilations in this environment.

Since:

0.2.0 ~2021.05.19

diagnostic

@NotNull
protected final @NotNull Diagnostic diagnostic

The diagnostic manager in this enlivenment.

Since:

0.2.0 ~2021.05.19

meta

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

The additional meta-data of this sketch.

Since:

0.2.0 ~2021.05.21

compilationSet

@Nullable
protected @Nullable @UnmodifiableView java.util.Set<Compilation> compilationSet

A set of the compilations in this environment.

Since:

0.2.0 ~2021.05.23

Constructor Detail

EnvironmentImpl

public EnvironmentImpl()

Method Detail

compilationSet

@NotNull
public @NotNull java.util.Set<Compilation> compilationSet()

Description copied from interface: Environment

Return a set view containing the compilations in this environment.

Specified by:

compilationSet in interface Environment

Returns:

a view of the compilations in this.

getCompilation

@Nullable
public @Nullable Compilation getCompilation(@NotNull
                                                       @NotNull Document document)

Description copied from interface: Environment

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

Specified by:

getCompilation in interface 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.

getCompilation

@Nullable
public @Nullable Compilation getCompilation(@NotNull
                                                       @NotNull java.lang.String name)

Description copied from interface: Environment

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.

Specified by:

getCompilation in interface 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.

getDiagnostic

@NotNull
public @NotNull Diagnostic getDiagnostic()

Description copied from interface: Environment

Return the diagnostic manager in this environment.

Specified by:

getDiagnostic in interface Environment

Returns:

the diagnostic manager.

getMeta

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

Description copied from interface: Environment

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.

Specified by:

getMeta in interface Environment

Returns:

the meta-data map of this.

optCompilation

@NotNull
public @NotNull Compilation optCompilation(@NotNull
                                                     @NotNull Document document)

Description copied from interface: Environment

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.

Specified by:

optCompilation in interface Environment

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.

setCompilation

public void setCompilation(@NotNull
                           @NotNull Document document,
                           @NotNull
                           @NotNull Compilation compilation)

Description copied from interface: Environment

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

Specified by:

setCompilation in interface Environment

Parameters:

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

compilation - the compilation.