io.flamingock.api.template

Class AbstractSimpleTemplate<SHARED_CONFIG,APPLY,ROLLBACK>

java.lang.Object

io.flamingock.api.template.AbstractChangeTemplate<SHARED_CONFIG,APPLY,ROLLBACK>

io.flamingock.api.template.AbstractSimpleTemplate<SHARED_CONFIG,APPLY,ROLLBACK>

Type Parameters:

SHARED_CONFIG - the type of shared configuration

APPLY - the type of the apply payload

ROLLBACK - the type of the rollback payload

All Implemented Interfaces:

ChangeTemplate<SHARED_CONFIG,APPLY,ROLLBACK>, ReflectionMetadataProvider

public abstract class AbstractSimpleTemplate<SHARED_CONFIG,APPLY,ROLLBACK>
extends AbstractChangeTemplate<SHARED_CONFIG,APPLY,ROLLBACK>

Abstract base class for templates with a single apply/rollback step.

Use this class when your template processes a single operation that may have an optional rollback. The YAML structure for this template type is:

 id: create-users-table
 template: SqlTemplate
 apply: "CREATE TABLE users ..."
 rollback: "DROP TABLE users"
 

The framework will automatically create a TemplateStep from the apply/rollback fields in the YAML and inject it via setStep(io.flamingock.api.template.TemplateStep<APPLY, ROLLBACK>).

Field Summary

Fields

Modifier and Type	Field and Description
protected TemplateStep<APPLY,ROLLBACK>	step

Fields inherited from class io.flamingock.api.template.AbstractChangeTemplate

changeId, configuration, isTransactional

Constructor Summary

Constructors

Constructor and Description
AbstractSimpleTemplate(java.lang.Class<?>... additionalReflectiveClass)

Method Summary

Modifier and Type	Method and Description
APPLY	getApply() Convenience method to get the apply payload from the step.
ROLLBACK	getRollback() Convenience method to get the rollback payload from the step.
TemplateStep<APPLY,ROLLBACK>	getStep() Returns the step containing the apply and optional rollback payloads.
boolean	hasRollback() Checks if this template has a rollback payload defined.
boolean	hasStep() Checks if this template has a step set.
void	setStep(TemplateStep<APPLY,ROLLBACK> step) Sets the step containing the apply and optional rollback payloads.

Methods inherited from class io.flamingock.api.template.AbstractChangeTemplate

getApplyPayloadClass, getConfigurationClass, getReflectiveClasses, getRollbackPayloadClass, setChangeId, setConfiguration, setTransactional

Methods inherited from class java.lang.Object

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

Field Detail

step

protected TemplateStep<APPLY,ROLLBACK> step

Constructor Detail

AbstractSimpleTemplate

public AbstractSimpleTemplate(java.lang.Class<?>... additionalReflectiveClass)

Method Detail

setStep

public void setStep(TemplateStep<APPLY,ROLLBACK> step)

Sets the step containing the apply and optional rollback payloads.

Parameters:

step - the template step

getStep

public TemplateStep<APPLY,ROLLBACK> getStep()

Returns the step containing the apply and optional rollback payloads.

Returns:

the template step, or null if not set

hasStep

public boolean hasStep()

Checks if this template has a step set.

Returns:

true if a step is set

getApply

public APPLY getApply()

Convenience method to get the apply payload from the step.

Returns:

the apply payload, or null if no step is set

getRollback

public ROLLBACK getRollback()

Convenience method to get the rollback payload from the step.

Returns:

the rollback payload, or null if no step is set or no rollback defined

hasRollback

public boolean hasRollback()

Checks if this template has a rollback payload defined.

Returns:

true if a step is set and it has a rollback payload