org.jamplate.impl

Class Jamplate

java.lang.Object

org.jamplate.impl.Jamplate

public final class Jamplate
extends java.lang.Object

An all-in-one jamplate processor.

Since:

0.2.0 ~2021.05.23

Version:

0.2.0

Author:

LSafer

Field Summary

Fields

Modifier and Type	Field and Description
static @NotNull Analyzer	ANALYZER The default jamplate analyzer.
static @NotNull Processor	ANALYZER_PROCESSOR A processor for the jamplate analyzer.
static @NotNull Compiler	COMPILER The default jamplate compiler.
static @NotNull Processor	COMPILER_PROCESSOR A processor for the jamplate compiler.
static @NotNull Initializer	INITIALIZER The default jamplate initializer.
static @NotNull Parser	PARSER An all-in-one parser used by the jamplate default implementation.
static @NotNull Processor	PARSER_PROCESSOR A processor wrapper for the jamplate parser.
static @NotNull Processor	PROCESSOR A processor that analyzes the default jamplate components searching for known jamplate specs.

Method Summary

Modifier and Type	Method and Description
static boolean	compile(@NotNull Environment environment, Document... documents) Compile the given documents to the given environment.
static boolean	execute(@NotNull Environment environment, Compilation... compilations) Execute the given compilations in order with respect to the given environment.
static boolean	execute(@NotNull Environment environment, @NotNull java.util.function.Function<Compilation,Memory> memorySupplier, Compilation... compilations) Execute the given compilations in order with respect to the given environment.

Methods inherited from class java.lang.Object

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

Field Detail

ANALYZER

@NotNull
public static final @NotNull Analyzer ANALYZER

The default jamplate analyzer.

Since:

0.2.0 ~2021.05.29

ANALYZER_PROCESSOR

@NotNull
public static final @NotNull Processor ANALYZER_PROCESSOR

A processor for the jamplate analyzer.

Since:

0.2.0 ~2021.05.30

COMPILER

@NotNull
public static final @NotNull Compiler COMPILER

The default jamplate compiler.

Since:

0.2.0 ~2021.05.21

COMPILER_PROCESSOR

@NotNull
public static final @NotNull Processor COMPILER_PROCESSOR

A processor for the jamplate compiler.

Since:

0.2.0 ~2021.05.30

PARSER

@NotNull
public static final @NotNull Parser PARSER

An all-in-one parser used by the jamplate default implementation.

Since:

0.2.0 ~2021.05.17

PARSER_PROCESSOR

@NotNull
public static final @NotNull Processor PARSER_PROCESSOR

A processor wrapper for the jamplate parser.

Since:

0.2.0 ~2021.05.30

PROCESSOR

@NotNull
public static final @NotNull Processor PROCESSOR

A processor that analyzes the default jamplate components searching for known jamplate specs.

Since:

0.2.0 ~2021.05.20

INITIALIZER

@NotNull
public static final @NotNull Initializer INITIALIZER

The default jamplate initializer.

Since:

0.2.0 ~2021.05.29

Method Detail

compile

@Contract(mutates="param1,param2")
public static boolean compile(@NotNull
                                                                  @NotNull Environment environment,
                                                                  @Nullable
                                                                  Document... documents)

Compile the given documents to the given environment.
Null documents in the given array are ignored.

Parameters:

environment - the environment to compile to.

documents - the documents to be compiled.

Returns:

true, if all of the given documents was successfully compiled.

Throws:

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

Since:

0.2.0 ~2021.05.31

execute

public static boolean execute(@NotNull
                              @NotNull Environment environment,
                              @Nullable
                              Compilation... compilations)

Execute the given compilations in order with respect to the given environment.
Null compilations or non-compiled compilations in the given array are ignored.

Parameters:

environment - the environment to execute on.

compilations - the compilations to be executed (in order).

Returns:

true, if all of the given compilations was successfully executed.

Throws:

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

Since:

0.2.0 ~2021.05.31

execute

@Contract(mutates="param1,param2")
public static boolean execute(@NotNull
                                                                  @NotNull Environment environment,
                                                                  @NotNull
                                                                  @NotNull java.util.function.Function<Compilation,Memory> memorySupplier,
                                                                  @Nullable
                                                                  Compilation... compilations)

Execute the given compilations in order with respect to the given environment.
Null compilations or non-compiled compilations in the given array are ignored.

Parameters:

environment - the environment to execute on.

memorySupplier - a supplier used to create new memory instances.

compilations - the compilations to be executed (in order).

Returns:

true, if all of the given compilations was successfully executed.

Throws:

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

Since:

0.2.0 ~2021.05.31