Index (butterfly-extensions-api 3.2.2 API)

A B C D E F G H I L M N O P R S T U V W

A

Abort - Class in com.paypal.butterfly.extensions.api.utilities: Aborts the transformation immediately.
Abort() - Constructor for class com.paypal.butterfly.extensions.api.utilities.Abort: This transformation utility abort the transformation.
Abort(String) - Constructor for class com.paypal.butterfly.extensions.api.utilities.Abort: This transformation utility abort the transformation.
abortOnFailure(boolean) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: If set to true, abort the whole transformation if validation or execution fails.
abortOnFailure(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Abort the whole transformation if validation or execution fails.
absolute(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: There are two ways to specify the file, or folder, the transformation utility is suppose to perform against.
absolute(String, String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Same as TransformationUtility.absolute(String, String), however, the absolute file is set with an additional relative path, which is defined via parameter additionalRelativePath.
add(Class<? extends TransformationTemplate>) - Method in class com.paypal.butterfly.extensions.api.Extension: Adds a new transformation template class to the set
add(TransformationUtility) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Adds a new transformation utility to the end of the list.
add(TransformationUtility, String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Adds a new transformation utility to the end of the list.
add(TransformationUtility) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
add(TransformationUtility, String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
AddElement<T extends TransformationOperation> - Interface in com.paypal.butterfly.extensions.api.operations: This interface should be implemented by TransformationOperation subclasses that intend to modify a project by adding elements to it, standardizing the behavior and API if the element to be added already exists.
AddElement.IfPresent - Enum in com.paypal.butterfly.extensions.api.operations: Possible behaviors in case the element to be added already exists.
AddElementTO<T extends AddElementTO> - Class in com.paypal.butterfly.extensions.api.operations: Convenience class with AddElement implementation ready for TransformationOperation subclasses.
AddElementTO() - Constructor for class com.paypal.butterfly.extensions.api.operations.AddElementTO
addMultiple(TransformationOperation, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Adds a special transformation utility to perform multiple transformation operations against multiple files specified as a list, held as a transformation context attribute
addMultiple(TransformationOperation, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
ApplicationValidationException - Exception in com.paypal.butterfly.extensions.api.exception: Thrown whenever the application to be transformed is not in a valid state.
ApplicationValidationException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ApplicationValidationException
ApplicationValidationException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ApplicationValidationException
applyPropertiesFromContext(TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Applies transformation utility properties during transformation time, but prior to execution (right before it).
automaticResolution(File) - Method in class com.paypal.butterfly.extensions.api.Extension: Butterfly might be able to automatically identify the type of application and which transformation template to be applied to it.

B

BASELINE - Static variable in class com.paypal.butterfly.extensions.api.TransformationTemplate
ButterflyException - Exception in com.paypal.butterfly.extensions.api.exception: Butterfly generic checked exception.
ButterflyException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ButterflyException
ButterflyException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ButterflyException
ButterflyRuntimeException - Exception in com.paypal.butterfly.extensions.api.exception: Butterfly generic runtime exception.
ButterflyRuntimeException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ButterflyRuntimeException
ButterflyRuntimeException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.ButterflyRuntimeException

C

ChangeOrRemoveElement<T extends TransformationOperation> - Interface in com.paypal.butterfly.extensions.api.operations: This interface should be implemented by TransformationOperation subclasses that intend to modify a project by changing or modify elements, standardizing the behavior and API in the absence of the element to be manipulated.
ChangeOrRemoveElement.IfNotPresent - Enum in com.paypal.butterfly.extensions.api.operations: Possible behaviors in case the element to be changed or removed is not present.
ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO> - Class in com.paypal.butterfly.extensions.api.operations: Convenience class with ChangeOrRemoveElement implementation ready for TransformationOperation subclasses.
ChangeOrRemoveElementTO() - Constructor for class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
changeTypeOnWarning() - Method in class com.paypal.butterfly.extensions.api.PerformResult
changeTypeOnWarning() - Method in class com.paypal.butterfly.extensions.api.TOExecutionResult
changeTypeOnWarning() - Method in class com.paypal.butterfly.extensions.api.TUExecutionResult
checkDependencies(TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Check if any of dependency of this TU failed.
checkForBlankString(String, String) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility: Check if value is a blank String, if it is, then a TransformationDefinitionException is thrown.
checkForEmptyString(String, String) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility: Check if value is an empty String, if it is, then a TransformationDefinitionException is thrown.
checkForNull(String, Object) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility: Check if value is null, if it is, then a TransformationDefinitionException is thrown.
clone() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Creates and returns a clone object identical to the original object, except for the "has been performed" flag, which is set to false in the clone object to be returned.
clone() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
com.paypal.butterfly.extensions.api - package com.paypal.butterfly.extensions.api: API component to be used by Butterfly extensions when providing their transformation and upgrade templates.
com.paypal.butterfly.extensions.api.exception - package com.paypal.butterfly.extensions.api.exception: Butterfly exceptions.
com.paypal.butterfly.extensions.api.operations - package com.paypal.butterfly.extensions.api.operations: Basic transformation operations.
com.paypal.butterfly.extensions.api.upgrade - package com.paypal.butterfly.extensions.api.upgrade: API to support defining upgrade transformation templates.
com.paypal.butterfly.extensions.api.utilities - package com.paypal.butterfly.extensions.api.utilities: Basic transformation utilities.
compare(File, File) - Method in class com.paypal.butterfly.extensions.api.DoubleCondition: Returns true only if the compared files meet the comparison criteria established and implemented by the subclass
contains(String) - Method in interface com.paypal.butterfly.extensions.api.TransformationContext: Return true if the transformation context has an attribute whose name is name
ContextAttributeRetriever<T> - Class in com.paypal.butterfly.extensions.api: Transformation utility to fetch transformation context attributes post transformation time, since they are always set during transformation time.
ContextAttributeRetriever() - Constructor for class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
ContextAttributeRetriever(String) - Constructor for class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
copy() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Creates and returns a copy object similar to the original object.

D

debug(String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
debug(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
debug(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
debug(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
dependencyFailureCheck() - Method in class com.paypal.butterfly.extensions.api.PerformResult
dependencyFailureCheck() - Method in class com.paypal.butterfly.extensions.api.TOExecutionResult
dependencyFailureCheck() - Method in class com.paypal.butterfly.extensions.api.TUExecutionResult
dependsOn(String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Add all transformation utilities this utility depends on.
DoubleCondition<T extends DoubleCondition> - Class in com.paypal.butterfly.extensions.api: Transformation utility condition to determine if a transformation utility should be executed or not, based on a two files criteria.
DoubleCondition() - Constructor for class com.paypal.butterfly.extensions.api.DoubleCondition: Condition to determine if a transformation utility should be executed or not.
DoubleCondition(String) - Constructor for class com.paypal.butterfly.extensions.api.DoubleCondition: Condition to determine if a transformation utility should be executed or not.

E

equals(Object) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Compare this instance against the specified object, and return true only if they are equal.
error(TransformationUtility, Exception, String) - Static method in class com.paypal.butterfly.extensions.api.PerformResult: This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
error(TransformationUtility, Exception) - Static method in class com.paypal.butterfly.extensions.api.PerformResult: This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
error(TransformationOperation, Exception) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult: Creates and returns a new TOExecutionResult.Type.ERROR result
error(TransformationOperation, Exception, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult: Creates and returns a new TOExecutionResult.Type.ERROR result
error(TransformationUtility, Exception) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
error(TransformationUtility, Exception, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
error(TransformationUtility, Object, Exception, String) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
executeIf(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: When set, this TU will only execute if this transformation context attribute is existent and its value is set to true (as String or Boolean).
executeIf(UtilityCondition) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: When set, this TU will only execute if this utilityCondition object, executed right before this TU, result in true.
executeUnless(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: When set, this TU will execute, unless this transformation context attribute is existent and its value is set to true (as String or Boolean).
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.DoubleCondition
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.FilterFiles
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: The implementation execution of this transformation utility.
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop: Returns, as its value, the condition to keep iterating over this loop
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.Abort
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.Log
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue
execution(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
ExecutionResult<S,R,T> - Class in com.paypal.butterfly.extensions.api: The meta-data object resulted after the TransformationUtility instance has been executed.
executionResult(TransformationUtility, ExecutionResult) - Static method in class com.paypal.butterfly.extensions.api.PerformResult: This means the utility has been executed, and the result type is defined based on the utility execution result type.
Extension<E> - Class in com.paypal.butterfly.extensions.api: A Butterfly third-party extension.
Extension() - Constructor for class com.paypal.butterfly.extensions.api.Extension

F

failIfNotPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement: Fail (TOExecutionResult.Type.ERROR) if the element to be changed or removed is not present
failIfNotPresent() - Method in class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
failIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement: Fail (TOExecutionResult.Type.ERROR) if the element to be added is already present
failIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO
FilterFiles - Class in com.paypal.butterfly.extensions.api: Transformation utility to filter a list of files based on a given SingleCondition, returning in a sub-list of files.
FilterFiles() - Constructor for class com.paypal.butterfly.extensions.api.FilterFiles: Utility to filter a list of files based on a given SingleCondition, returning in a sub-list of files
FilterFiles(SingleCondition) - Constructor for class com.paypal.butterfly.extensions.api.FilterFiles: Utility to filter a list of files based on a given SingleCondition, returning in a sub-list of files

G

get(String) - Method in interface com.paypal.butterfly.extensions.api.TransformationContext: Returns the attribute object associated with the key (which is the attribute name), or null, if there is none
getAbortionMessage() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns a message to be logged if a fail happens and transformation has to be aborted
getAbsoluteFile(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns an absolute path to the file or folder the transformation utility is supposed to perform against
getApplicationName() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Returns the name of the transformed application, Returns null if the application name is unknown.
getApplicationType() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Returns the type of the transformed application, Returns null if the application type is unknown.
getAttribute() - Method in class com.paypal.butterfly.extensions.api.DoubleCondition: Return the name of the transformation context attribute that refers to the file to be compared against the baseline file
getAttribute() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
getAttributeNames() - Method in class com.paypal.butterfly.extensions.api.utilities.Log: Returns a copy of the array containing all attribute names used by this Log transformation utility.
getAttributeValue() - Method in class com.paypal.butterfly.extensions.api.ContextAttributeRetriever: Returns the value of the transformation context attribute specified earlier.
getChildren() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations: Returns all TransformationOperation instances generated out of the transformation operation template.
getChildren() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
getChildren() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
getChildren() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
getCondition() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
getConditionTemplate() - Method in class com.paypal.butterfly.extensions.api.FilterFiles: Return the single condition template to be evaluated against all files
getConditionTemplate() - Method in class com.paypal.butterfly.extensions.api.MultipleConditions: Return the condition template
getContextAttributeName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Return the name to be used as key for the result of this utility when saved into the transformation context.
getDependencies() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns an unmodifiable list of names of utilities this utility instance depends on.
getDescription() - Method in class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
getDescription() - Method in class com.paypal.butterfly.extensions.api.Extension: Returns the extension description
getDescription() - Method in class com.paypal.butterfly.extensions.api.FilterFiles
getDescription() - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
getDescription() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
getDescription() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Returns the transformation template description
getDescription() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns a short one line, but SPECIFIC, description about the transformation utility, including mentioning the files and/or folders to be manipulated.
getDescription() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
getDescription() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.Abort
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.Log
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue
getDescription() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
getExecutionResult() - Method in class com.paypal.butterfly.extensions.api.PerformResult: Return the ExecutionResult object associated with this perform result
getExtensionClass() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Returns the class of the extension this transformation template belongs to
getFilesAttributes() - Method in class com.paypal.butterfly.extensions.api.FilterFiles: Return an array containing the name of transformation context attributes that hold the list of files to be filtered
getFilesAttributes() - Method in class com.paypal.butterfly.extensions.api.MultipleConditions: A copy of the array of transformation context attributes that hold list of Files which the condition should perform against.
getFilesAttributes() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations: Return an array containing the name of transformation context attributes that hold the list of files the operations should be performed against
getIfConditionAttributeName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Return the "if" condition attribute name associated with this transformation operation, or null, if there is none
getIterations() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
getKey() - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue: Returns he key used to get the map entry
getLogLevel() - Method in class com.paypal.butterfly.extensions.api.utilities.Log: Returns the log level
getLogMessage() - Method in class com.paypal.butterfly.extensions.api.utilities.Log: Returns the log message
getMapName() - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue: Return the name of the transformation context attribute that holds the map object
getMode() - Method in class com.paypal.butterfly.extensions.api.MultipleConditions: Return the evaluation mode
getName() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
getName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
getNextIteration() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
getNextStep() - Method in class com.paypal.butterfly.extensions.api.upgrade.UpgradeStep: Returns the next UpgradeStep.
getNextVersion() - Method in class com.paypal.butterfly.extensions.api.upgrade.UpgradeStep: Returns the version the application would be upgraded to
getOrCreateReadFile(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationOperation: Creates and returns a temporary read-only copy of the file to be modified.
getOrder() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns the execution order for this utility on its parent.
getParent() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns the transformation utility parent
getPerformResultTypes() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
getRelativePath() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns relative path (from the application root folder) to the file or folder the transformation utility is suppose to perform against
getRelativePath(File, File) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns a relative path from baselineFile to targetFile.
getResourceName() - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction: Returns the instruction resource name
getResult(String) - Method in interface com.paypal.butterfly.extensions.api.TransformationContext: Returns the performing result of the TransformationUtility identified by the specified name.
getRootPomFile(File) - Method in class com.paypal.butterfly.extensions.api.Extension: This is a convenience method in case the Extension subclass wants to implement its Extension.automaticResolution(File) method based on one or more Maven pom files
getSimpleClassName() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Returns the transformation template class simple name (see Class.getSimpleName()), or "AnonymousTransformationTemplate" if that is an anonymous class
getSimpleClassName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns the transformation utility class simple name (see Class.getSimpleName()), or "AnonymousTransformationUtility" if that is an anonymous class
getTemplate() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
getTemplateClasses() - Method in class com.paypal.butterfly.extensions.api.Extension: Returns a read-only set containing all transformation template classes
getTemplateOperation() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
getToExecutionResultTypes() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
getTransformationTemplate() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns the transformation template this utility belongs to.
getTuExecutionResultTypes() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
getUnlessConditionAttributeName() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Return the "unless" condition attribute name associated with this transformation operation, or null, if there is none
getUtilities() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Returns a read-only ordered list of transformation utilities to be executed, which defines the actual transformation offered by this template
getUtilities() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
getUtilityName() - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
getValue() - Method in class com.paypal.butterfly.extensions.api.TUExecutionResult: Returns the value returned by the transformation utility, which can be null
getVersion() - Method in class com.paypal.butterfly.extensions.api.Extension: Returns the extension version

H

hasBeenPerformed() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns true only if this utility has already been performed, even if the execution was skipped.
hashCode() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
hashCode(int, Object...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Calculates and return a hash code starting from the hash code generated from superclass

I

ifNotPresent - Variable in class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
ifPresent - Variable in class com.paypal.butterfly.extensions.api.operations.AddElementTO
info(String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
info(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
info(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
info(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
isAbortOnFailure() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Returns whether this operation aborts the transformation or not in case of an operation failure.
isBlank() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Returns true if this is a blank transformation template.
isExceptionType() - Method in class com.paypal.butterfly.extensions.api.PerformResult
isExceptionType() - Method in class com.paypal.butterfly.extensions.api.TOExecutionResult
isExceptionType() - Method in class com.paypal.butterfly.extensions.api.TUExecutionResult
isFileSet() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Return true only if a file has been set.
isSaveResult() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: This flag indicates whether the value produced by the transformation utility execution, and also its result object as a whole, should both be saved in the transformation context object.
iterate() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop: Returns a clone of this transformation utility loop ready for the next iteration

L

log(String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Deprecated.
log(Level, String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
log(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Deprecated.
log(Level, String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
log(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup: Deprecated.
log(Level, String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
log(String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup: Deprecated.
log(Level, String, String...) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
Log - Class in com.paypal.butterfly.extensions.api.utilities: Provides logging statements during transformation time.
Log() - Constructor for class com.paypal.butterfly.extensions.api.utilities.Log: Utility to provide logging statements during transformation time.
loop(TransformationUtility, int) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Execute an utility in a loop a number times specified in iterations
loop(TransformationUtility, String) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Execute an utility in a loop while the value in TransformationContext attribute is true.
loop(TransformationUtility, UtilityCondition) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Execute an utility in a loop while the execution value resulted by condition is true.

M

ManualInstruction - Class in com.paypal.butterfly.extensions.api.utilities: 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.
ManualInstruction(String, String) - Constructor for class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
MapValue - Class in com.paypal.butterfly.extensions.api.utilities: Obtains a specific entry from a Map object stored in the TransformationContext, and store its value as a new attribute in the transformation context.
MapValue() - Constructor for class com.paypal.butterfly.extensions.api.utilities.MapValue: This utility obtains a specific entry from a Map object stored in the transformation context, and store its value as a new attribute in the transformation context.
MapValue(String, Object) - Constructor for class com.paypal.butterfly.extensions.api.utilities.MapValue: This utility obtains a specific entry from a Map object stored in the transformation context, and store its value as a new attribute in the transformation context.
MultipleConditions - Class in com.paypal.butterfly.extensions.api: Transformation utility condition to determine if a transformation utility should be executed or not, based on a multiple files criteria.
MultipleConditions(SingleCondition) - Constructor for class com.paypal.butterfly.extensions.api.MultipleConditions: Perform one transformation utility condition against multiple files, returning true if at least one file meets the condition (default mode).
MultipleConditions.Mode - Enum in com.paypal.butterfly.extensions.api: Execution mode for MultipleConditions.
MultipleOperations - Class in com.paypal.butterfly.extensions.api: Transformation utility to perform multiple transformation operations.
MultipleOperations() - Constructor for class com.paypal.butterfly.extensions.api.MultipleOperations: Utility to perform multiple transformation operations.
MultipleOperations(TransformationOperation) - Constructor for class com.paypal.butterfly.extensions.api.MultipleOperations: Utility to perform multiple transformation operations.

N

newConditionInstance(File) - Method in class com.paypal.butterfly.extensions.api.FilterFiles: Creates a new single condition instance copying from this current object, but setting the file it should perform against based on the input parameters
newConditionInstance(File) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions: Creates a new condition instance copying from this current object, but setting the file it should perform against based on the input parameters
noOp(TransformationOperation, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult: Creates and returns a new TOExecutionResult.Type.NO_OP result
noOpIfNotPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement: Do nothing, not warn neither fail, (TOExecutionResult.Type.NO_OP) if the element to be changed or removed is not present
noOpIfNotPresent() - Method in class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
noOpIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement: Do nothing, not add, not warn neither fail, (TOExecutionResult.Type.NO_OP) if the element to be added is already present
noOpIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO
normalizeRelativePathSeparator(String) - Static method in class com.paypal.butterfly.extensions.api.TransformationUtility
nullResult(TransformationUtility) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
nullResult(TransformationUtility, String) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult

O

overwriteIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement: Overwrite and not warn (TOExecutionResult.Type.SUCCESS) if the element to be added is already present
overwriteIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO

P

perform(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationOperation
perform(File, TransformationContext) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Performs the transformation utility against the application to be transformed.
PerformResult - Class in com.paypal.butterfly.extensions.api: The meta-data object resulted after the TransformationUtility instance has been performed.
PerformResult.Type - Enum in com.paypal.butterfly.extensions.api: The type of result after the TransformationUtility instance has been performed.

R

relative(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Sets the relative path from the application root folder to the file or folder the transformation utility should perform against.
ResultCondition - Class in com.paypal.butterfly.extensions.api.utilities: Checks the perform result, and optionally execution result as well, of a TransformationUtility instance.
ResultCondition() - Constructor for class com.paypal.butterfly.extensions.api.utilities.ResultCondition
ResultCondition(String) - Constructor for class com.paypal.butterfly.extensions.api.utilities.ResultCondition
run() - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop: Returns the TU instance to be run in the this iteration.

S

set(String, String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: This method allows setting properties in this transformation utility during transformation time, right before its execution.
setAbortionMessage(String) - Method in class com.paypal.butterfly.extensions.api.utilities.Abort: Set the reason to abort the transformation
setAttribute(String) - Method in class com.paypal.butterfly.extensions.api.DoubleCondition: 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)
setAttributeName(String) - Method in class com.paypal.butterfly.extensions.api.ContextAttributeRetriever
setAttributeNames(String...) - Method in class com.paypal.butterfly.extensions.api.utilities.Log: Sets names of transformation context attributes to be used as arguments for this log statement
setBlank(boolean) - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate: Sets whether this is a blank transformation template or not.
setBlank(boolean) - Method in class com.paypal.butterfly.extensions.api.upgrade.UpgradeStep
setCondition(int) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop: In this case the condition to execute the next iteration is based on a pre-defined number of iterations to be executed.
setCondition(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop: In this case the condition to execute the next iteration is based on a TransformationContext attribute (specified by its name) whose value is true or false.
setCondition(UtilityCondition) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop: In this case the condition to execute the next iteration is based on a UtilityCondition object whose result is true or false.
setConditionTemplate(SingleCondition) - Method in class com.paypal.butterfly.extensions.api.FilterFiles: Set the single condition template to be evaluated against all files
setConditionTemplate(SingleCondition) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions: Set the utility condition template used to create conditions to be evaluated against the list of files
setContextAttributeName(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Set the name to be used as key for the result of this utility when saved into the transformation context.
setDescription(String) - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
setFiles(String...) - Method in class com.paypal.butterfly.extensions.api.FilterFiles: Sets one or more transformation context attributes that hold list of Files which the single condition should be evaluated against.
setFiles(String...) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions: Sets one or more transformation context attributes that hold list of Files which the condition should perform against.
setFiles(String...) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations: Sets one or more transformation context attributes that hold list of Files which the transformation operations should perform against.
setKey(Object) - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue: Set the key used to get the map entry
setLogLevel(Level) - Method in class com.paypal.butterfly.extensions.api.utilities.Log: Sets the log level
setLogMessage(String) - Method in class com.paypal.butterfly.extensions.api.utilities.Log: Sets the log message
setMapName(String) - Method in class com.paypal.butterfly.extensions.api.utilities.MapValue: Set the name of the transformation context attribute that holds the map object
setMode(MultipleConditions.Mode) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions: Set the evaluation mode.
setName(String) - Method in class com.paypal.butterfly.extensions.api.FilterFiles
setName(String) - Method in class com.paypal.butterfly.extensions.api.MultipleConditions
setName(String) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
setName(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Set this transformation utility instance name.
setName(String) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop
setOperationTemplate(TransformationOperation) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations: Sets the template of transformation operation to be performed against all specified files.
setParent(TransformationUtilityParent, int) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Register this utility to its parent, and also assign it a name based on the parent name and order of execution.
setPerformResultTypes(PerformResult.Type...) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
setProperties(String, String) - Method in class com.paypal.butterfly.extensions.api.MultipleOperations: This setter is similar to TransformationUtility.set(String, String), however it is more powerful, because it allows setting, during transformation time, different properties values for each operation of a MultipleOperations.
setPropertySetter() - Method in class com.paypal.butterfly.extensions.api.MultipleOperations
setResourceName(String) - Method in class com.paypal.butterfly.extensions.api.utilities.ManualInstruction
setSaveResult(boolean) - Method in class com.paypal.butterfly.extensions.api.TransformationOperation
setSaveResult(boolean) - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Sets whether or not the value produced by the transformation utility execution, and also its result object as a whole, should both be saved in the transformation context object.
setTemplate(TransformationUtility) - Method in class com.paypal.butterfly.extensions.api.TransformationUtilityLoop: Sets the transformation utility instance to be used as a template.
setToExecutionResultTypes(TOExecutionResult.Type...) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
setTuExecutionResultTypes(TUExecutionResult.Type...) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
setUtilityName(String) - Method in class com.paypal.butterfly.extensions.api.utilities.ResultCondition
SingleCondition<T extends SingleCondition> - Class in com.paypal.butterfly.extensions.api: Transformation utility condition to determine if a transformation utility should be executed or not, based on an one file criteria.
SingleCondition() - Constructor for class com.paypal.butterfly.extensions.api.SingleCondition
skippedCondition(TransformationUtility, String) - Static method in class com.paypal.butterfly.extensions.api.PerformResult: This means the utility has not been executed because its pre-requisite condition is not true
skippedDependency(TransformationUtility, String) - Static method in class com.paypal.butterfly.extensions.api.PerformResult: This means the utility has not been executed because one or more of its dependencies "failed".
success(TransformationOperation, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult: Creates and returns a new TOExecutionResult.Type.SUCCESS result

T

TemplateResolutionException - Exception in com.paypal.butterfly.extensions.api.exception: Thrown by Extension.automaticResolution(File) whenever a transformation template cannot be resolved.
TemplateResolutionException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TemplateResolutionException: This exception is thrown by Extension.automaticResolution(File) whenever transformation template cannot be resolved
TemplateResolutionException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TemplateResolutionException: This exception is thrown by Extension.automaticResolution(File) whenever transformation template cannot be resolved
TOExecutionResult - Class in com.paypal.butterfly.extensions.api: The meta-data object resulted after the TransformationOperation instance has been executed.
TOExecutionResult.Type - Enum in com.paypal.butterfly.extensions.api: The type of result after the TransformationOperation instance has been executed.
toString() - Method in class com.paypal.butterfly.extensions.api.Extension
toString() - Method in class com.paypal.butterfly.extensions.api.TransformationTemplate
toString() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility
TransformationContext - Interface in com.paypal.butterfly.extensions.api: Holds meta-data information to be shared among transformation utility objects, allowing communication among them, and helping the transformation process.
TransformationDefinitionException - Exception in com.paypal.butterfly.extensions.api.exception: Thrown whenever a transformation template definition is not well formed.
TransformationDefinitionException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationDefinitionException
TransformationDefinitionException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationDefinitionException
TransformationOperation<T extends TransformationOperation> - Class in com.paypal.butterfly.extensions.api: Special type of TransformationUtility that applies a modification to the project.
TransformationOperation() - Constructor for class com.paypal.butterfly.extensions.api.TransformationOperation
TransformationOperationException - Exception in com.paypal.butterfly.extensions.api.exception: Thrown whenever an unexpected behavior or result during execution of a TransformationOperation.
TransformationOperationException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationOperationException
TransformationOperationException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationOperationException
TransformationTemplate - Class in com.paypal.butterfly.extensions.api: A template made of a set of transformation utilities to be applied against an application to be transformed.
TransformationTemplate() - Constructor for class com.paypal.butterfly.extensions.api.TransformationTemplate
TransformationUtility<T extends TransformationUtility> - Class in com.paypal.butterfly.extensions.api: Gathers information about the project to be transformed without applying any modification on it.
TransformationUtility() - Constructor for class com.paypal.butterfly.extensions.api.TransformationUtility
TransformationUtilityException - Exception in com.paypal.butterfly.extensions.api.exception: Thrown whenever an unexpected behavior or result during execution of a TransformationUtility.
TransformationUtilityException(String) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationUtilityException
TransformationUtilityException(String, Throwable) - Constructor for exception com.paypal.butterfly.extensions.api.exception.TransformationUtilityException
TransformationUtilityGroup - Class in com.paypal.butterfly.extensions.api: Group of transformation utilities.
TransformationUtilityGroup() - Constructor for class com.paypal.butterfly.extensions.api.TransformationUtilityGroup
TransformationUtilityLoop - Class in com.paypal.butterfly.extensions.api: Allows the execution of any transformation utility instance, including a TransformationUtilityGroup, multiple times in a loop.
TransformationUtilityLoop() - Constructor for class com.paypal.butterfly.extensions.api.TransformationUtilityLoop: Allows the execution of any transformation utility instance, including a TransformationUtilityGroup, multiple times in a loop.
TransformationUtilityLoop(TransformationUtility) - Constructor for class com.paypal.butterfly.extensions.api.TransformationUtilityLoop: Allows the execution of any transformation utility instance, including a TransformationUtilityGroup, multiple times in a loop.
TUExecutionResult - Class in com.paypal.butterfly.extensions.api: The meta-data object resulted after the TransformationUtility instance has been executed.
TUExecutionResult.Type - Enum in com.paypal.butterfly.extensions.api: The type of result after the TransformationUtility instance has been executed.

U

UpgradeStep - Class in com.paypal.butterfly.extensions.api.upgrade: A special type of upgrade template that takes an application from one minor version to the next subsequent available version.
UpgradeStep() - Constructor for class com.paypal.butterfly.extensions.api.upgrade.UpgradeStep
UTILITY_NAME_SYNTAX - Static variable in class com.paypal.butterfly.extensions.api.TransformationUtility
UtilityCondition<U extends UtilityCondition> - Class in com.paypal.butterfly.extensions.api: Condition to determine if a transformation utility should be executed or not.
UtilityCondition() - Constructor for class com.paypal.butterfly.extensions.api.UtilityCondition

V

value(TransformationUtility, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
value(TransformationUtility, String, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.MultipleConditions.Mode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.PerformResult.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.TOExecutionResult.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.paypal.butterfly.extensions.api.TUExecutionResult.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.paypal.butterfly.extensions.api.MultipleConditions.Mode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.paypal.butterfly.extensions.api.operations.AddElement.IfPresent: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement.IfNotPresent: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.paypal.butterfly.extensions.api.PerformResult.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.paypal.butterfly.extensions.api.TOExecutionResult.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.paypal.butterfly.extensions.api.TUExecutionResult.Type: Returns an array containing the constants of this enum type, in the order they are declared.

W

warnButAddIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement: Warn, but add, (TOExecutionResult.Type.WARNING) if the element to be added is already present
warnButAddIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO
warnIfNotPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement: Warn (TOExecutionResult.Type.WARNING) if the element to be changed or removed is not present
warnIfNotPresent() - Method in class com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO
warning(TransformationOperation) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult: Creates and returns a new TOExecutionResult.Type.WARNING result
warning(TransformationOperation, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult: Creates and returns a new TOExecutionResult.Type.WARNING result
warning(TransformationOperation, Exception) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult: Creates and returns a new TOExecutionResult.Type.WARNING result
warning(TransformationOperation, Exception, String) - Static method in class com.paypal.butterfly.extensions.api.TOExecutionResult: Creates and returns a new TOExecutionResult.Type.WARNING result
warning(TransformationUtility, String, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
warning(TransformationUtility, Exception, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
warning(TransformationUtility, Exception, String, Object) - Static method in class com.paypal.butterfly.extensions.api.TUExecutionResult
warnNotAddIfPresent() - Method in interface com.paypal.butterfly.extensions.api.operations.AddElement: Warn and do not add (TOExecutionResult.Type.WARNING) if the element to be added is already present
warnNotAddIfPresent() - Method in class com.paypal.butterfly.extensions.api.operations.AddElementTO
wasFileExplicitlySet() - Method in class com.paypal.butterfly.extensions.api.TransformationUtility: Return true only if a file has been set explicitly either via TransformationUtility.relative(String), TransformationUtility.absolute(String) or TransformationUtility.absolute(String, String).

A B C D E F G H I L M N O P R S T U V W