org.jamplate.impl.initializer

Class ProcessorsInitializer

java.lang.Object

org.jamplate.impl.initializer.ProcessorsInitializer

All Implemented Interfaces:

Initializer

public class ProcessorsInitializer
extends java.lang.Object
implements Initializer

An initializer that initializes new compilations using a list of processors.

Since:

0.2.0 ~2021.05.29

Version:

0.2.0

Author:

LSafer

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull java.util.List<Processor>	processors The processors used by this initializer.

Constructor Summary

Constructors

Constructor and Description
ProcessorsInitializer(@NotNull java.util.List<Processor> processors) Construct a new initializer that initializes using the given processors.
ProcessorsInitializer(Processor... processors) Construct a new initializer that initializes using the given processors.

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.

Methods inherited from class java.lang.Object

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

Field Detail

processors

@NotNull
protected final @NotNull java.util.List<Processor> processors

The processors used by this initializer.

Since:

0.2.0 ~2021.05.29

Constructor Detail

ProcessorsInitializer

public ProcessorsInitializer(@Nullable
                             Processor... processors)

Construct a new initializer that initializes using the given processors.
Null processors in the array will be ignored.

Parameters:

processors - the processors to be used by the constructed initializer.

Throws:

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

Since:

0.2.0 ~2021.05.29

ProcessorsInitializer

public ProcessorsInitializer(@NotNull
                             @NotNull java.util.List<Processor> processors)

Construct a new initializer that initializes using the given processors.
Null processors in the list will be ignored.

Parameters:

processors - the processors to be used by the constructed initializer.

Throws:

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

Since:

0.2.0 ~2021.05.29

Method Detail

initialize

public boolean initialize(@NotNull
                          @NotNull Environment environment,
                          @Nullable
                          Document... documents)

Description copied from interface: Initializer

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

Specified by:

initialize in interface Initializer

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.