com.paypal.butterfly.extensions.api.utilities

Class Abort

java.lang.Object

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

com.paypal.butterfly.extensions.api.utilities.Abort

All Implemented Interfaces:

java.lang.Cloneable

public class Abort
extends TransformationUtility<Abort>

Aborts the transformation immediately. An abort message may be specified. The abort can also be conditional by using TransformationUtility.executeIf(String) or TransformationUtility.executeUnless(String)

Field Summary

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

UTILITY_NAME_SYNTAX

Constructor Summary

Constructors

Constructor and Description
Abort() This transformation utility abort the transformation.
Abort(java.lang.String abortionMessage) This transformation utility abort the transformation.

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.
Abort	setAbortionMessage(java.lang.String abortionMessage) Set the reason to abort the transformation

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

Abort

public Abort()

This transformation utility abort the transformation. A reason for abortion may be specified. The abortion can also be conditional by using TransformationUtility.executeIf(String) or TransformationUtility.executeUnless(String)

Abort

public Abort(java.lang.String abortionMessage)

This transformation utility abort the transformation. An abortion message may be specified. The abortion can also be conditional by using TransformationUtility.executeIf(String) or TransformationUtility.executeUnless(String)

Parameters:

abortionMessage - the reason to abort the transformation;

Method Detail

setAbortionMessage

public Abort setAbortionMessage(java.lang.String abortionMessage)

Set the reason to abort the transformation

Parameters:

abortionMessage - the reason to abort the transformation

Returns:

this transformation utility instance

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<Abort>

Returns:

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

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<Abort>

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