com.paypal.butterfly.extensions.api.utilities

Class ResultCondition

java.lang.Object

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

com.paypal.butterfly.extensions.api.UtilityCondition<ResultCondition>

com.paypal.butterfly.extensions.api.utilities.ResultCondition

All Implemented Interfaces:

java.lang.Cloneable

public class ResultCondition
extends UtilityCondition<ResultCondition>

Checks the perform result, and optionally execution result as well, of a TransformationUtility instance. If a result for the specified utility name is not found, this condition returns false, but with a warning.

Field Summary

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

UTILITY_NAME_SYNTAX

Constructor Summary

Constructors

Constructor and Description
ResultCondition()
ResultCondition(java.lang.String utilityName)

Method Summary

Modifier and Type	Method and Description
protected TUExecutionResult	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.
PerformResult.Type[]	getPerformResultTypes()
TOExecutionResult.Type[]	getToExecutionResultTypes()
TUExecutionResult.Type[]	getTuExecutionResultTypes()
java.lang.String	getUtilityName()
ResultCondition	setPerformResultTypes(PerformResult.Type... performResultTypes)
ResultCondition	setToExecutionResultTypes(TOExecutionResult.Type... toExecutionResultTypes)
ResultCondition	setTuExecutionResultTypes(TUExecutionResult.Type... tuExecutionResultTypes)
ResultCondition	setUtilityName(java.lang.String utilityName)

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

ResultCondition

public ResultCondition()

ResultCondition

public ResultCondition(java.lang.String utilityName)

Method Detail

setUtilityName

public ResultCondition setUtilityName(java.lang.String utilityName)

setPerformResultTypes

public ResultCondition setPerformResultTypes(PerformResult.Type... performResultTypes)

setTuExecutionResultTypes

public ResultCondition setTuExecutionResultTypes(TUExecutionResult.Type... tuExecutionResultTypes)

setToExecutionResultTypes

public ResultCondition setToExecutionResultTypes(TOExecutionResult.Type... toExecutionResultTypes)

getUtilityName

public java.lang.String getUtilityName()

getPerformResultTypes

public PerformResult.Type[] getPerformResultTypes()

getTuExecutionResultTypes

public TUExecutionResult.Type[] getTuExecutionResultTypes()

getToExecutionResultTypes

public TOExecutionResult.Type[] getToExecutionResultTypes()

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

Returns:

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

execution

protected TUExecutionResult 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<ResultCondition>

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