com.paypal.butterfly.extensions.api

Class DoubleCondition<T extends DoubleCondition>

java.lang.Object

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

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

com.paypal.butterfly.extensions.api.DoubleCondition<T>

All Implemented Interfaces:

Cloneable

public abstract class DoubleCondition<T extends DoubleCondition>
extends UtilityCondition<T>

Transformation utility condition to determine if a transformation utility should be executed or not, based on a two files criteria. Every DoubleUtilityCondition subclass result type must always be boolean. The criteria to this type of condition is based on two files (when comparing if two XML files are equal for example). For conditions based on evaluating a single file see SingleCondition. For conditions based on multiple files see MultipleConditions
Important: it returns true if both files don't exist, and it returns false if only one of them exists.

Author:

facarvalho

See Also:

SingleCondition, MultipleConditions

Field Summary

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

UTILITY_NAME_SYNTAX

Constructor Summary

Constructors

Constructor and Description
DoubleCondition() Condition to determine if a transformation utility should be executed or not.
DoubleCondition(String attribute) Condition to determine if a transformation utility should be executed or not.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	compare(File baselineFile, File comparisonFile) Returns true only if the compared files meet the comparison criteria established and implemented by the subclass
protected TUExecutionResult	execution(File transformedAppFolder, TransformationContext transformationContext) The implementation execution of this transformation utility.
String	getAttribute() Return the name of the transformation context attribute that refers to the file to be compared against the baseline file
T	setAttribute(String attribute) Set the name of the transformation context attribute that refers to the file to be compared against the baseline file, which is set by regular TransformationUtility methods, like TransformationUtility.relative(String) or TransformationUtility.absolute(String)

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

abortOnFailure, abortOnFailure, abortOnFailure, absolute, absolute, applyPropertiesFromContext, checkDependencies, checkForBlankString, checkForEmptyString, checkForNull, clone, copy, dependsOn, equals, executeIf, executeIf, executeUnless, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, 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

DoubleCondition

public DoubleCondition()

Condition to determine if a transformation utility should be executed or not. Every DoubleUtilityCondition subclass result type must always be boolean. The criteria to this type of condition is based on two files (when comparing if two XML files are equal for example)

DoubleCondition

public DoubleCondition(String attribute)

Condition to determine if a transformation utility should be executed or not. Every DoubleUtilityCondition subclass result type must always be boolean. The criteria to this type of condition is based on two files (when comparing if two XML files are equal for example)

Parameters:

attribute - the name of the transformation context attribute that refers to the file to be compared against the baseline file

Method Detail

getAttribute

public String getAttribute()

Return the name of the transformation context attribute that refers to the file to be compared against the baseline file

Returns:

the name of the transformation context attribute that refers to the file to be compared against the baseline file

setAttribute

public T setAttribute(String attribute)

Set the name of the transformation context attribute that refers to the file to be compared against the baseline file, which is set by regular TransformationUtility methods, like TransformationUtility.relative(String) or TransformationUtility.absolute(String)

Parameters:

attribute - the name of the transformation context attribute that refers to the file to be compared against the baseline file

Returns:

this utility condition instance

execution

protected TUExecutionResult execution(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<T extends DoubleCondition>

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

compare

protected abstract boolean compare(File baselineFile,
                                   File comparisonFile)

Returns true only if the compared files meet the comparison criteria established and implemented by the subclass

Parameters:

baselineFile - the baseline file used for comparison

comparisonFile - the file to be compared against the baseline file

Returns:

this utility condition instance