com.paypal.butterfly.extensions.api.upgrade

Class UpgradeStep

java.lang.Object

com.paypal.butterfly.extensions.api.TransformationTemplate

com.paypal.butterfly.extensions.api.upgrade.UpgradeStep

public abstract class UpgradeStep
extends TransformationTemplate

A special type of upgrade template that takes an application from one minor version to the next subsequent available version.

Field Summary

Fields inherited from class com.paypal.butterfly.extensions.api.TransformationTemplate

BASELINE

Constructor Summary

Constructors

Constructor and Description
UpgradeStep()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getCurrentVersion() Returns the current version of the application, in other words, the version the application would be upgraded from when this upgrade template is executed
abstract UpgradeStep	getNextStep() Returns the next UpgradeStep.
abstract java.lang.String	getNextVersion() Returns the version the application would be upgraded to
void	setBlank(boolean blank) Sets whether this is a blank transformation template or not.

Methods inherited from class com.paypal.butterfly.extensions.api.TransformationTemplate

add, add, addMultiple, debug, debug, getApplicationName, getApplicationType, getChildren, getDescription, getExtensionClass, getName, getSimpleClassName, getUtilities, info, info, isBlank, log, log, log, log, loop, loop, loop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeStep

public UpgradeStep()

Method Detail

getNextVersion

public abstract java.lang.String getNextVersion()

Returns the version the application would be upgraded to

Returns:

the version the application would be upgraded to

getNextStep

public abstract UpgradeStep getNextStep()

Returns the next UpgradeStep. Returns null if there is no UpgradeStep associated with the next version

Returns:

the next UpgradeStep

setBlank

public void setBlank(boolean blank)

Description copied from class: TransformationTemplate

Sets whether this is a blank transformation template or not. Commonly transformations are done by first copying all files and folders the current application has, and then performing a set of ordered operations, one by one, on top of those files, until the final result is reached. However, a few times transformations might be so massive that it would make more sense to take a reverse approach, starting from a blank folder, followed by a set of copies from the original application folder plus eventual operations. This reverse approach is called "blank transformation". By default transformation templates are not blank. Notice that UpgradeStep cannot be blank.

Overrides:

setBlank in class TransformationTemplate

Parameters:

blank - whether this is a blank transformation template or not

getCurrentVersion

public abstract java.lang.String getCurrentVersion()

Returns the current version of the application, in other words, the version the application would be upgraded from when this upgrade template is executed

Returns:

the current version of the application