io.flamingock.api.annotations

Annotation Type EnableFlamingock

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface EnableFlamingock

Core annotation for configuring Flamingock pipeline execution. This annotation must be placed on a class to enable Flamingock processing and define how the pipeline should be configured.

Pipeline Configuration

The annotation supports two mutually exclusive pipeline configuration modes:

1. File-based Configuration

Use configFile() to reference a YAML pipeline definition:

 @EnableFlamingock(configFile = "config/pipeline.yaml")
 public class MyMigrationConfig {
     // Configuration class
 }
 

2. Annotation-based Configuration

Use stages() to define the pipeline inline:

 @EnableFlamingock(
     stages = {
         @Stage(type = StageType.SYSTEM, location = "com.example.system"),
         @Stage(type = StageType.LEGACY, location = "com.example.init"),
         @Stage(location = "com.example.migrations")
     }
 )
 public class MyMigrationConfig {
     // Configuration class
 }
 

Validation Rules

• Either configFile() OR stages() must be specified (mutually exclusive)
• At least one configuration mode must be provided
• Maximum of 1 stage with type StageType.SYSTEM is allowed
• Maximum of 1 stage with type StageType.LEGACY is allowed

Since:

1.0

See Also:

Stage

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	configFile Specifies the path to a YAML pipeline configuration file for file-based configuration.
Stage[]	stages Defines the pipeline stages.
boolean	strictStageMapping If true, the annotation processor will validate that all code-based changes (classes annotated with @Change) are mapped to some stage.

Element Detail

stages

public abstract Stage[] stages

Defines the pipeline stages. Each stage represents a logical grouping of changes that execute in sequence.

Mutually exclusive with configFile(). When using stages, do not specify a pipeline file.

Stage type restrictions:

• Maximum of 1 stage with type StageType.SYSTEM is allowed
• Maximum of 1 stage with type StageType.LEGACY is allowed
• Unlimited stages with type StageType.DEFAULT are allowed

Example:

 stages = {
     @Stage(type = StageType.SYSTEM, location = "com.example.system"),
     @Stage(type = StageType.LEGACY, location = "com.example.init"),
     @Stage(type = StageType.DEFAULT, location = "com.example.changes")
 }
 

Returns:

array of stage configurations

See Also:

Stage

Default:

{}

configFile

public abstract java.lang.String configFile

Specifies the path to a YAML pipeline configuration file for file-based configuration. The file path supports both absolute paths and classpath resources.

Mutually exclusive with stages(). When using a pipeline file, do not specify stages in the annotation.

File resolution order:

1. Direct file path (absolute or relative to working directory)
2. Classpath resource in src/main/resources/
3. Classpath resource in src/test/resources/

Example:

 configFile = "config/flamingock-pipeline.yaml"
 

Returns:

the pipeline file path, or empty string for annotation-based configuration

Default:

""

strictStageMapping

public abstract boolean strictStageMapping

If true, the annotation processor will validate that all code-based changes (classes annotated with @Change) are mapped to some stage. When unmapped changes are found and this flag is true**(default)**, a RuntimeException is thrown at compilation time. When false, only a warning is emitted.

Default:

true