com.paypal.butterfly.extensions.api.utilities

Class ManualInstruction

java.lang.Object

com.paypal.butterfly.extensions.api.TransformationUtility<ManualInstruction>

com.paypal.butterfly.extensions.api.utilities.ManualInstruction

All Implemented Interfaces:

java.lang.Cloneable

public class ManualInstruction
extends TransformationUtility<ManualInstruction>

Registers a manual instruction, also known as "post-upgrade instruction", which can be seen as a transformation operation that is too complex to be automated, but that should at least be recognized and reported by Butterfly.
In the end of the transformation, every manual instruction is reported in order of registration as Markdown (.md) files.

Field Summary

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

UTILITY_NAME_SYNTAX

Constructor Summary

Constructors

Constructor and Description
ManualInstruction(java.lang.String description, java.lang.String resourceName)

Method Summary

Modifier and Type	Method and Description
protected ExecutionResult	execution(java.io.File transformedAppFolder, TransformationContext transformationContext) The implementation execution of this transformation utility.
java.lang.String	getDescription() Returns a short one line, but SPECIFIC, description about the transformation utility, including mentioning the files and/or folders to be manipulated.
java.lang.String	getResourceName() Returns the instruction resource name
ManualInstruction	setDescription(java.lang.String description)
ManualInstruction	setResourceName(java.lang.String resourceName)

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

abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getSimpleClassName, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isAbortOnFailure, isFileSet, isSaveResult, normalizeRelativePathSeparator, perform, relative, set, setContextAttributeName, setName, setParent, setSaveResult, toString, wasFileExplicitlySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ManualInstruction

public ManualInstruction(java.lang.String description,
                         java.lang.String resourceName)

Method Detail

setDescription

public ManualInstruction setDescription(java.lang.String description)

setResourceName

public ManualInstruction setResourceName(java.lang.String resourceName)

getDescription

public java.lang.String getDescription()

Description copied from class: TransformationUtility

Returns a short one line, but SPECIFIC, description about the transformation utility, including mentioning the files and/or folders to be manipulated. This is supposed to be an one line statement about the specific transformation utility that was executed. This would be used for example in log statements or user interfaces.

Specified by:

getDescription in class TransformationUtility<ManualInstruction>

Returns:

a short one line, but specific, description about the transformation utility

getResourceName

public java.lang.String getResourceName()

Returns the instruction resource name

Returns:

the instruction resource name

execution

protected ExecutionResult execution(java.io.File transformedAppFolder,
                                    TransformationContext transformationContext)

Description copied from class: TransformationUtility

The implementation execution of this transformation utility. The returned object is the result of the execution and is always automatically saved in the transformation context as a new attribute (whose key is the name of the transformation utility), unless TransformationUtility.isSaveResult() returns false.
Important: this method MUST NEVER return null, and it must catch its executions exceptions and wrap them into a ExecutionResult error object.

Specified by:

execution in class TransformationUtility<ManualInstruction>

Parameters:

transformedAppFolder - the folder where the transformed application code is

transformationContext - the transformation context object

Returns:

an object with the result of this execution, to be better defined by the concrete utility class, since its type is generic