com.paypal.butterfly.extensions.api

Class TransformationTemplate

java.lang.Object

com.paypal.butterfly.extensions.api.TransformationTemplate

Direct Known Subclasses:

UpgradeStep

public abstract class TransformationTemplate
extends java.lang.Object

A template made of a set of transformation utilities to be applied against an application to be transformed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASELINE

Constructor Summary

Constructors

Constructor and Description
TransformationTemplate()

Method Summary

Modifier and Type	Method and Description
java.lang.String	add(TransformationUtility utility) Adds a new transformation utility to the end of the list.
java.lang.String	add(TransformationUtility utility, java.lang.String utilityName) Adds a new transformation utility to the end of the list.
java.lang.String	addMultiple(TransformationOperation templateOperation, java.lang.String... attributes) Adds a special transformation utility to perform multiple transformation operations against multiple files specified as a list, held as a transformation context attribute
void	debug(java.lang.String debugMessage)
void	debug(java.lang.String debugMessage, java.lang.String... attributeNames)
java.lang.String	getApplicationName() Returns the name of the transformed application, Returns null if the application name is unknown.
java.lang.String	getApplicationType() Returns the type of the transformed application, Returns null if the application type is unknown.
java.util.List<TransformationUtility>	getChildren()
abstract java.lang.String	getDescription() Returns the transformation template description
abstract java.lang.Class<? extends Extension>	getExtensionClass() Returns the class of the extension this transformation template belongs to
java.lang.String	getName()
protected java.lang.String	getSimpleClassName() Returns the transformation template class simple name (see Class.getSimpleName()), or "AnonymousTransformationTemplate" if that is an anonymous class
java.util.List<TransformationUtility>	getUtilities() Returns a read-only ordered list of transformation utilities to be executed, which defines the actual transformation offered by this template
void	info(java.lang.String infoMessage)
void	info(java.lang.String infoMessage, java.lang.String... attributeNames)
boolean	isBlank() Returns true if this is a blank transformation template.
void	log(org.slf4j.event.Level logLevel, java.lang.String logMessage)
void	log(org.slf4j.event.Level logLevel, java.lang.String logMessage, java.lang.String... attributeNames)
void	log(java.lang.String logMessage) Deprecated.
void	log(java.lang.String logMessage, java.lang.String... attributeNames) Deprecated.
java.lang.String	loop(TransformationUtility utility, int iterations) Execute an utility in a loop a number times specified in iterations
java.lang.String	loop(TransformationUtility utility, java.lang.String attribute) Execute an utility in a loop while the value in TransformationContext attribute is true.
java.lang.String	loop(TransformationUtility utility, UtilityCondition condition) Execute an utility in a loop while the execution value resulted by condition is true.
void	setBlank(boolean blank) Sets whether this is a blank transformation template or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

BASELINE

public static final java.lang.String BASELINE

See Also:

Constant Field Values

Constructor Detail

TransformationTemplate

public TransformationTemplate()

Method Detail

getExtensionClass

public abstract java.lang.Class<? extends Extension> getExtensionClass()

Returns the class of the extension this transformation template belongs to

Returns:

the class of the extension this transformation template belongs to

getDescription

public abstract java.lang.String getDescription()

Returns the transformation template description

Returns:

the transformation template description

add

public final java.lang.String add(TransformationUtility utility)

Adds a new transformation utility to the end of the list. Also, if no name has been set for this utility yet, the template names the utility based on this template's name and the order of execution.
This method also register the template within the utility, which means a transformation utility instance can be registered to ONLY ONE transformation template

Parameters:

utility - the utility to be added

Returns:

the utility name

add

public final java.lang.String add(TransformationUtility utility,
                                  java.lang.String utilityName)

Adds a new transformation utility to the end of the list. It sets the utility name before adding it though.
This method also register the template within the utility, which means a transformation utility instance can be registered to ONLY ONE transformation template

Parameters:

utility - the utility to be added

utilityName - the name to be set to the utility before adding it

Returns:

the utility name

addMultiple

public final java.lang.String addMultiple(TransformationOperation templateOperation,
                                          java.lang.String... attributes)

Adds a special transformation utility to perform multiple transformation operations against multiple files specified as a list, held as a transformation context attribute

Parameters:

templateOperation - a template of transformation operation to be performed against all specified files

attributes - one or more transformation context attributes that hold list of Files which the transformation operations should perform against

Returns:

the utility name

loop

public final java.lang.String loop(TransformationUtility utility,
                                   int iterations)

Execute an utility in a loop a number times specified in iterations

Parameters:

utility - the utility to be executed each iteration of the loop. To execute more than one, use a TransformationUtilityGroup

iterations - the number of iterations to be executed

Returns:

the utility name

loop

public final java.lang.String loop(TransformationUtility utility,
                                   java.lang.String attribute)

Execute an utility in a loop while the value in TransformationContext attribute is true. The defined is specified based on its name, specified in attribute. If the attribute value is not a boolean, or if non-existent, it will be treated as false.

Parameters:

utility - the utility to be executed each iteration of the loop. To execute more than one, use a TransformationUtilityGroup

attribute - the name of the transformation context attribute to hold the loop condition

Returns:

the utility name

loop

public final java.lang.String loop(TransformationUtility utility,
                                   UtilityCondition condition)

Execute an utility in a loop while the execution value resulted by condition is true. The TransformationUtility object referenced by condition won't be saved to the TransformationContext, it will be executed exclusively to the scope of this loop execution. Any result other than a boolean true value, including failures, will be treated as false.

Parameters:

utility - the utility to be executed each iteration of the loop. To execute more than one, use a TransformationUtilityGroup

condition - the UtilityCondition object whose execution result will be used as the loop condition

Returns:

the utility name

log

@Deprecated
public final void log(java.lang.String logMessage)

Deprecated.

info

public final void info(java.lang.String infoMessage)

debug

public final void debug(java.lang.String debugMessage)

log

public final void log(org.slf4j.event.Level logLevel,
                      java.lang.String logMessage)

log

@Deprecated
public final void log(java.lang.String logMessage,
                                  java.lang.String... attributeNames)

Deprecated.

info

public final void info(java.lang.String infoMessage,
                       java.lang.String... attributeNames)

debug

public final void debug(java.lang.String debugMessage,
                        java.lang.String... attributeNames)

log

public final void log(org.slf4j.event.Level logLevel,
                      java.lang.String logMessage,
                      java.lang.String... attributeNames)

getUtilities

public final java.util.List<TransformationUtility> getUtilities()

Returns a read-only ordered list of transformation utilities to be executed, which defines the actual transformation offered by this template

Returns:

the list of utilities to transform the application,

getChildren

public java.util.List<TransformationUtility> getChildren()

getName

public final java.lang.String getName()

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

getApplicationType

public java.lang.String getApplicationType()

Returns the type of the transformed application, Returns null if the application type is unknown. This method is used mostly for meta-data purposes, such as when providing transformation metrics.

Returns:

the type of the transformed application

getApplicationName

public java.lang.String getApplicationName()

Returns the name of the transformed application, Returns null if the application name is unknown. This method is used mostly for meta-data purposes, such as when providing transformation metrics.

Returns:

the name of the transformed application

getSimpleClassName

protected java.lang.String getSimpleClassName()

Returns the transformation template class simple name (see Class.getSimpleName()), or "AnonymousTransformationTemplate" if that is an anonymous class

Returns:

the transformation template class simple name

setBlank

public void setBlank(boolean blank)

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.

Parameters:

blank - whether this is a blank transformation template or not

isBlank

public boolean isBlank()

Returns true if this is a blank transformation template. See setBlank(boolean).

Returns:

true if this is a blank transformation template