io.flamingock.internal.core.task.loaded

Class AbstractReflectionLoadedTask

java.lang.Object

io.flamingock.internal.common.core.task.AbstractTaskDescriptor

io.flamingock.internal.core.task.loaded.AbstractLoadedTask

io.flamingock.internal.core.task.loaded.AbstractReflectionLoadedTask

All Implemented Interfaces:

io.flamingock.internal.common.core.error.validation.Validatable<StageValidationContext>, io.flamingock.internal.common.core.task.TaskDescriptor, java.lang.Comparable<io.flamingock.internal.common.core.task.TaskDescriptor>

Direct Known Subclasses:

AbstractLoadedChange

public abstract class AbstractReflectionLoadedTask
extends AbstractLoadedTask

Abstract base class for loaded tasks that use Java reflection to execute changes.

This class serves as the foundation for both code-based and template-based changes, providing common reflection-based execution capabilities. It handles the distinction between the source file (where the change is defined) and the implementation class (where the logic resides).

Change Types

• Code-based: Changes defined directly in Java classes with @Change annotation
• Template-based: Changes defined in YAML/JSON templates that reference implementation ChangeTemplate classes

Reflection Usage

This class uses reflection to:

• Instantiate change classes via constructor
• Invoke execution methods (annotated with @Apply)
• Optionally invoke rollback methods (annotated with @Rollback)

Subclass Responsibilities

Concrete implementations must provide:

• getConstructor() - Constructor for instantiating the change
• getApplyMethod() - Method to execute the change
• getRollbackMethod() - Optional method for rollback operations

Since:

6.0

See Also:

AbstractLoadedTask

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	fileName The source file name where this change is defined.
protected java.lang.Class<?>	implementationClass The Java class that contains the actual change execution logic.

Fields inherited from class io.flamingock.internal.common.core.task.AbstractTaskDescriptor

author, id, legacy, order, recovery, runAlways, source, system, targetSystem, transactional

Constructor Summary

Constructors

Constructor and Description
AbstractReflectionLoadedTask(java.lang.String fileName, java.lang.String id, java.lang.String order, java.lang.String author, java.lang.Class<?> implementationClass, boolean runAlways, boolean transactional, boolean system, io.flamingock.internal.common.core.task.TargetSystemDescriptor targetSystem, io.flamingock.internal.common.core.task.RecoveryDescriptor recovery, boolean legacy)

Method Summary

Modifier and Type	Method and Description
abstract java.lang.reflect.Method	getApplyMethod() Returns the method to be invoked for executing the change.
abstract java.lang.reflect.Constructor<?>	getConstructor() Returns the constructor to be used for instantiating the change class.
java.lang.String	getFileName() Returns the source file name where this change is defined.
java.lang.Class<?>	getImplementationClass() Returns the Java class containing the change execution logic.
abstract java.util.Optional<java.lang.reflect.Method>	getRollbackMethod() Returns the optional method to be invoked for rolling back the change.

Methods inherited from class io.flamingock.internal.common.core.task.AbstractTaskDescriptor

equals, getAuthor, getId, getOrder, getRecovery, getSource, getTargetSystem, hashCode, isLegacy, isRunAlways, isSystem, isTransactional, setAuthor, setId, setLegacy, setOrder, setRecovery, setRunAlways, setSource, setSystem, setTargetSystem, setTransactional, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.flamingock.internal.common.core.error.validation.Validatable

getValidationErrors, isValid

Methods inherited from interface io.flamingock.internal.common.core.task.TaskDescriptor

compareTo, isSortable, isStandard, pretty

Field Detail

fileName

protected final java.lang.String fileName

The source file name where this change is defined.

This represents the original source of the change definition:

• Template-based: The YAML/JSON template file name (e.g., "create-users.yaml")
• Code-based: The Java class name containing the @Change annotation

Note: This may differ from the implementationClass in template-based scenarios where the template references a separate implementation class.

implementationClass

protected final java.lang.Class<?> implementationClass

The Java class that contains the actual change execution logic.

This class is used for reflection-based instantiation and method invocation:

• Template-based: A class implementing ChangeTemplate interface, referenced by the template file
• Code-based: The same class as indicated by fileName, containing @Change annotation

This class must have:

• A constructor accessible via getConstructor()
• An execution method accessible via getApplyMethod()
• Optionally, a rollback method accessible via getRollbackMethod()

Constructor Detail

AbstractReflectionLoadedTask

public AbstractReflectionLoadedTask(java.lang.String fileName,
                                    java.lang.String id,
                                    java.lang.String order,
                                    java.lang.String author,
                                    java.lang.Class<?> implementationClass,
                                    boolean runAlways,
                                    boolean transactional,
                                    boolean system,
                                    io.flamingock.internal.common.core.task.TargetSystemDescriptor targetSystem,
                                    io.flamingock.internal.common.core.task.RecoveryDescriptor recovery,
                                    boolean legacy)

Method Detail

getFileName

public java.lang.String getFileName()

Returns the source file name where this change is defined.

Returns:

the file name (template file for template-based, class name for code-based)

See Also:

fileName

getImplementationClass

public java.lang.Class<?> getImplementationClass()

Returns the Java class containing the change execution logic.

Returns:

the implementation class used for reflection-based execution

See Also:

implementationClass

getConstructor

public abstract java.lang.reflect.Constructor<?> getConstructor()

Returns the constructor to be used for instantiating the change class.

The constructor should be accessible and may require dependency injection parameters based on the change's requirements.

Specified by:

getConstructor in class AbstractLoadedTask

Returns:

the constructor for creating instances of the implementation class

getApplyMethod

public abstract java.lang.reflect.Method getApplyMethod()

Returns the method to be invoked for executing the change.

This method typically:

• Is annotated with @Apply
• Contains the main change logic
• May accept dependency-injected parameters

Specified by:

getApplyMethod in class AbstractLoadedTask

Returns:

the method to execute the change logic

getRollbackMethod

public abstract java.util.Optional<java.lang.reflect.Method> getRollbackMethod()

Returns the optional method to be invoked for rolling back the change.

This method, if present:

• Is annotated with @Rollback
• Contains logic to undo the changes made by the execution method
• May accept dependency-injected parameters

Specified by:

getRollbackMethod in class AbstractLoadedTask

Returns:

an Optional containing the rollback method, or empty if no rollback is defined