io.flamingock.internal.common.core.preview

Class PreviewStage.AbstractBuilder<T extends PreviewStage>

java.lang.Object

io.flamingock.internal.common.core.preview.PreviewStage.AbstractBuilder<T>

Direct Known Subclasses:

PreviewStage.DefaultBuilder, SystemPreviewStage.SystemBuilder

Enclosing class:

PreviewStage

public abstract static class PreviewStage.AbstractBuilder<T extends PreviewStage>
extends java.lang.Object

Builder for constructing PreviewStage instances.

A PreviewStage represents a stage containing one or more AbstractPreviewTask units, which can be defined either:

• Explicitly via setChanges(Collection)
• Implicitly by parsing templated YAML files located in a specified resources directory or source package

If tasks are to be loaded from a source package, both setSourcesPackage(String) and setSourcesRoots(Collection) must be provided. Optionally, setResourcesRoot(String) should be set to specify the root of the source tree (e.g., src/main/java, src/main/kotlin, etc.).

The builder enforces consistency in task ordering: if all tasks are sortable, they will be sorted; if only some are sortable, an exception will be thrown.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method and Description
T	build() Builds and returns a new PreviewStage instance based on the configured parameters.
protected abstract T	buildInstance(java.lang.String name, java.lang.String description, java.lang.String sourcesPackage, java.lang.String resourcesDir, java.util.Collection<AbstractPreviewTask> allDescriptors)
PreviewStage.AbstractBuilder<T>	setChanges(java.util.Collection<? extends AbstractPreviewTask> changes) Sets a collection of AbstractPreviewTask implementations directly.
PreviewStage.AbstractBuilder<T>	setDescription(java.lang.String description) Sets the description of the stage.
PreviewStage.AbstractBuilder<T>	setName(java.lang.String name) Sets the name of the stage.
PreviewStage.AbstractBuilder<T>	setParallel(boolean parallel) Sets whether tasks should be applied in parallel.
PreviewStage.AbstractBuilder<T>	setResourcesDir(java.lang.String resourcesDir) Sets the relative directory path inside the resources or source root where templated YAML files are located.
PreviewStage.AbstractBuilder<T>	setResourcesRoot(java.lang.String resourcesRoot) Sets the root directory of the resources or source files (e.g., src/main/java).
PreviewStage.AbstractBuilder<T>	setSourcesPackage(java.lang.String sourcesPackage) Sets the fully qualified package name where YAML changes reside (e.g., com.example.changes).
PreviewStage.AbstractBuilder<T>	setSourcesRoots(java.util.Collection<java.lang.String> sourcesRoots) Sets the collection of source root directories (e.g., src/main/java, src/main/kotlin).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBuilder

protected AbstractBuilder()

Method Detail

setName

public PreviewStage.AbstractBuilder<T> setName(java.lang.String name)

Sets the name of the stage. This is required before calling build().

Parameters:

name - the name of the stage

Returns:

this builder instance

setDescription

public PreviewStage.AbstractBuilder<T> setDescription(java.lang.String description)

Sets the description of the stage.

Parameters:

description - the description of the stage

Returns:

this builder instance

setSourcesRoots

public PreviewStage.AbstractBuilder<T> setSourcesRoots(java.util.Collection<java.lang.String> sourcesRoots)

Sets the collection of source root directories (e.g., src/main/java, src/main/kotlin). Used in conjunction with setSourcesPackage(String) to locate YAML changes.

Parameters:

sourcesRoots - collection of source root paths

Returns:

this builder instance

setSourcesPackage

public PreviewStage.AbstractBuilder<T> setSourcesPackage(java.lang.String sourcesPackage)

Sets the fully qualified package name where YAML changes reside (e.g., com.example.changes). Must be used together with setSourcesRoots(Collection).

Parameters:

sourcesPackage - the package name

Returns:

this builder instance

setResourcesRoot

public PreviewStage.AbstractBuilder<T> setResourcesRoot(java.lang.String resourcesRoot)

Sets the root directory of the resources or source files (e.g., src/main/java). Used to resolve the relative path to YAML resources when combined with setResourcesDir(String).

Parameters:

resourcesRoot - the root directory

Returns:

this builder instance

setResourcesDir

public PreviewStage.AbstractBuilder<T> setResourcesDir(java.lang.String resourcesDir)

Sets the relative directory path inside the resources or source root where templated YAML files are located.

Parameters:

resourcesDir - the directory inside the resources root

Returns:

this builder instance

setChanges

public PreviewStage.AbstractBuilder<T> setChanges(java.util.Collection<? extends AbstractPreviewTask> changes)

Sets a collection of AbstractPreviewTask implementations directly.

Parameters:

changes - the collection of change task classes

Returns:

this builder instance

setParallel

public PreviewStage.AbstractBuilder<T> setParallel(boolean parallel)

Sets whether tasks should be applied in parallel.

Parameters:

parallel - true to enable parallel execution; false otherwise

Returns:

this builder instance

build

public T build()

Builds and returns a new PreviewStage instance based on the configured parameters.

Returns:

a new PreviewStage

Throws:

java.lang.RuntimeException - if the name is not set or no changes are provided

buildInstance

@NotNull
protected abstract T buildInstance(java.lang.String name,
                                            java.lang.String description,
                                            java.lang.String sourcesPackage,
                                            java.lang.String resourcesDir,
                                            java.util.Collection<AbstractPreviewTask> allDescriptors)