org.jamplate.model.function

Interface Initializer

All Known Implementing Classes:

ProcessorsInitializer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Initializer

The initializer is a function that introduces/initializes compilations for the documents provided to it in the environment provided to it.

Since:

0.2.0 ~2021.05.29

Version:

0.2.0

Author:

LSafer

Method Summary

Modifier and Type	Method and Description
boolean	initialize(@NotNull Environment environment, Document... documents) Initialize compilations for the given documents in the given environment.

Method Detail

initialize

@Contract(mutates="param1")
boolean initialize(@NotNull
                                                @NotNull Environment environment,
                                                @Nullable
                                                Document... documents)

Initialize compilations for the given documents in the given environment.
Null documents in the array will be ignored.

Parameters:

environment - the environment to initialize the compilations in.

documents - the documents to initialize compilations for.

Returns:

true, if any compilation was initialized for any of the given documents in the given compilation, false if there was already a compilation foreach of the given documents in the given environment and this initializer has done nothing to any of them.

Throws:

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

java.lang.RuntimeException - if any runtime exception occurs.

java.lang.Error - if any unexpected/non-recoverable exception occurs.

Since:

0.2.0 ~2021.05.29