io.flamingock.api.annotations

Annotation Type ChangeTemplate

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

Marks a class as a Flamingock change template and configures its execution mode.

All template classes must extend AbstractChangeTemplate and be annotated with this annotation to specify whether they process single or multiple steps.

The id field is mandatory and must match the template: field in YAML pipeline definitions. This decouples template identity from Java class naming.

Simple templates (default, multiStep = false):

 id: create-users-table
 template: sql-template
 apply: "CREATE TABLE users (id INT PRIMARY KEY)"
 rollback: "DROP TABLE users"
 

Steppable templates (multiStep = true) process multiple operations:

 id: setup-orders
 template: mongo-template
 steps:
   - apply: { type: createCollection, collection: orders }
     rollback: { type: dropCollection, collection: orders }
   - apply: { type: insert, collection: orders, ... }
     rollback: { type: delete, collection: orders, ... }
 

Steppable rollback behavior:

• On failure, previously successful steps are rolled back in reverse order
• Steps without rollback are skipped during rollback

See Also:

AbstractChangeTemplate

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name Unique identifier for this template.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	multiStep When true, the template expects a steps array in YAML.
java.lang.Class<?>[]	reflectiveClasses Classes that need reflection registration for GraalVM native image, beyond what is already inferable from the template's generic type parameters (the configuration, apply payload, and rollback payload classes are auto-registered by the framework).
boolean	rollbackPayloadRequired When true (default), change authors must provide rollback payloads in YAML.

Element Detail

name

public abstract java.lang.String name

Unique identifier for this template. The YAML template: field must match this ID.

Returns:

the template identifier

multiStep

public abstract boolean multiStep

When true, the template expects a steps array in YAML. When false (default), it expects apply and optional rollback at root.

Returns:

true for steppable templates, false for simple templates

Default:

false

rollbackPayloadRequired

public abstract boolean rollbackPayloadRequired

When true (default), change authors must provide rollback payloads in YAML. When false, rollback payloads are optional.

Returns:

true if rollback payloads are required, false otherwise

Default:

true

reflectiveClasses

public abstract java.lang.Class<?>[] reflectiveClasses

Classes that need reflection registration for GraalVM native image, beyond what is already inferable from the template's generic type parameters (the configuration, apply payload, and rollback payload classes are auto-registered by the framework).

Use this when a template's apply/rollback methods touch classes that aren't part of its generic type signature — for example, a helper class instantiated reflectively inside the template body.

Defaults to empty. Most templates won't need to set it.

Returns:

additional classes to reflection-register

Default:

{}