io.flamingock.api.template

Class AbstractChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>

java.lang.Object

io.flamingock.api.template.AbstractChangeTemplate<SHARED_CONFIGURATION_FIELD,APPLY_FIELD,ROLLBACK_FIELD>

Type Parameters:

SHARED_CONFIGURATION_FIELD - shared configuration type (use TemplateVoid if none)

APPLY_FIELD - apply payload type

ROLLBACK_FIELD - rollback payload type

All Implemented Interfaces:

ChangeTemplate<SHARED_CONFIGURATION_FIELD,APPLY_FIELD,ROLLBACK_FIELD>

public abstract class AbstractChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>
extends java.lang.Object
implements ChangeTemplate<SHARED_CONFIGURATION_FIELD,APPLY_FIELD,ROLLBACK_FIELD>

Base class for creating Flamingock change templates.

Extend this class and annotate with ChangeTemplate to create custom templates. The annotation's steppable attribute determines the YAML structure.

Use @ChangeTemplate (default steppable = false) for simple templates with single apply/rollback fields.

Use @ChangeTemplate(steppable = true) for steppable templates with multiple steps.

See Also:

ChangeTemplate

Field Summary

Fields

Modifier and Type	Field and Description
protected APPLY_FIELD	applyPayload
protected java.lang.String	changeId
protected SHARED_CONFIGURATION_FIELD	configuration
protected boolean	isTransactional
protected ROLLBACK_FIELD	rollbackPayload

Constructor Summary

Constructors

Constructor and Description
AbstractChangeTemplate()

Method Summary

Modifier and Type	Method and Description
java.lang.Class<APPLY_FIELD>	getApplyPayloadClass()
java.lang.Class<SHARED_CONFIGURATION_FIELD>	getConfigurationClass()
java.lang.Class<ROLLBACK_FIELD>	getRollbackPayloadClass()
void	setApplyPayload(APPLY_FIELD applyPayload)
void	setChangeId(java.lang.String changeId)
void	setConfiguration(SHARED_CONFIGURATION_FIELD configuration)
void	setRollbackPayload(ROLLBACK_FIELD rollbackPayload)
void	setTransactional(boolean isTransactional)

Methods inherited from class java.lang.Object

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

Field Detail

changeId

protected java.lang.String changeId

isTransactional

protected boolean isTransactional

configuration

protected SHARED_CONFIGURATION_FIELD extends TemplateField configuration

applyPayload

protected APPLY_FIELD extends TemplatePayload applyPayload

rollbackPayload

protected ROLLBACK_FIELD extends TemplatePayload rollbackPayload

Constructor Detail

AbstractChangeTemplate

public AbstractChangeTemplate()

Method Detail

setChangeId

public void setChangeId(java.lang.String changeId)

Specified by:

setChangeId in interface ChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>

setTransactional

public void setTransactional(boolean isTransactional)

Specified by:

setTransactional in interface ChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>

setConfiguration

public void setConfiguration(SHARED_CONFIGURATION_FIELD configuration)

Specified by:

setConfiguration in interface ChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>

setApplyPayload

public void setApplyPayload(APPLY_FIELD applyPayload)

Specified by:

setApplyPayload in interface ChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>

setRollbackPayload

public void setRollbackPayload(ROLLBACK_FIELD rollbackPayload)

Specified by:

setRollbackPayload in interface ChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>

getConfigurationClass

public java.lang.Class<SHARED_CONFIGURATION_FIELD> getConfigurationClass()

Specified by:

getConfigurationClass in interface ChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>

getApplyPayloadClass

public java.lang.Class<APPLY_FIELD> getApplyPayloadClass()

Specified by:

getApplyPayloadClass in interface ChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>

getRollbackPayloadClass

public java.lang.Class<ROLLBACK_FIELD> getRollbackPayloadClass()

Specified by:

getRollbackPayloadClass in interface ChangeTemplate<SHARED_CONFIGURATION_FIELD extends TemplateField,APPLY_FIELD extends TemplatePayload,ROLLBACK_FIELD extends TemplatePayload>