io.flamingock.api.annotations

Annotation Type Stage

public @interface Stage

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	location Specifies the location where changes are found.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	description
java.lang.String	name The name of the stage.

Element Detail

location

public abstract java.lang.String location

Specifies the location where changes are found. This field is mandatory.

The location format determines how it's interpreted:

• Package name: Contains dots and no slashes (e.g., "com.example.migrations") - Used to scan for annotated changes in the specified package
• Resource directory (relative): Starts with "resources/" (e.g., "resources/db/migrations") - Used to scan for template-based changes in the specified resources directory
• Resource directory (absolute): Starts with "/" (e.g., "/absolute/path/to/templates") - Used to scan for template-based changes in the specified absolute path

Returns:

the location where changes are found (mandatory)

name

public abstract java.lang.String name

The name of the stage. If not specified, the name will be automatically derived from the location.

Name derivation rules:

• Package: "com.example.migrations" → "migrations" (last segment)
• Resource path: "resources/db/migrations" → "migrations" (last segment)
• Absolute path: "/path/to/migrations" → "migrations" (last segment)

Returns:

the stage name, or empty string for auto-derived name

Default:

""

description

public abstract java.lang.String description

Default:

""