com.paypal.butterfly.extensions.api

Class FilterFiles

java.lang.Object

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

com.paypal.butterfly.extensions.api.FilterFiles

All Implemented Interfaces:

java.lang.Cloneable

public class FilterFiles
extends TransformationUtility<FilterFiles>

Transformation utility to filter a list of files based on a given SingleCondition, returning in a sub-list of files.

Field Summary

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

UTILITY_NAME_SYNTAX

Constructor Summary

Constructors

Constructor and Description
FilterFiles() Utility to filter a list of files based on a given SingleCondition, returning in a sub-list of files
FilterFiles(SingleCondition conditionTemplate) Utility to filter a list of files based on a given SingleCondition, returning in a sub-list of files

Method Summary

Modifier and Type	Method and Description
protected TUExecutionResult	execution(java.io.File transformedAppFolder, TransformationContext transformationContext) The implementation execution of this transformation utility.
SingleCondition	getConditionTemplate() Return the single condition template to be evaluated against all files
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[]	getFilesAttributes() Return an array containing the name of transformation context attributes that hold the list of files to be filtered
SingleCondition	newConditionInstance(java.io.File file) Creates a new single condition instance copying from this current object, but setting the file it should perform against based on the input parameters
FilterFiles	setConditionTemplate(SingleCondition conditionTemplate) Set the single condition template to be evaluated against all files
FilterFiles	setFiles(java.lang.String... filesAttributes) Sets one or more transformation context attributes that hold list of Files which the single condition should be evaluated against.
protected FilterFiles	setName(java.lang.String name) Set this transformation utility instance name.

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, setParent, setSaveResult, toString, wasFileExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterFiles

public FilterFiles()

Utility to filter a list of files based on a given SingleCondition, returning in a sub-list of files

FilterFiles

public FilterFiles(SingleCondition conditionTemplate)

Utility to filter a list of files based on a given SingleCondition, returning in a sub-list of files

Parameters:

conditionTemplate - the single condition template to be evaluated against all files

Method Detail

setFiles

public FilterFiles setFiles(java.lang.String... filesAttributes)

Sets one or more transformation context attributes that hold list of Files which the single condition should be evaluated against. If more than one attribute is specified, all list of files will be combined into a single one

Parameters:

filesAttributes - one or more transformation context attributes that hold list of Files which the condition should be evaluated against

Returns:

this transformation utility object

setConditionTemplate

public FilterFiles setConditionTemplate(SingleCondition conditionTemplate)

Set the single condition template to be evaluated against all files

Parameters:

conditionTemplate - the single condition template to be evaluated against all files

Returns:

this transformation utility object

setName

protected FilterFiles setName(java.lang.String name)

Description copied from class: TransformationUtility

Set this transformation utility instance name. If not set, a default name will be assigned at the time it is added to a parent.

Overrides:

setName in class TransformationUtility<FilterFiles>

Parameters:

name - transformation utility instance name

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

Returns:

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

getFilesAttributes

public java.lang.String[] getFilesAttributes()

Return an array containing the name of transformation context attributes that hold the list of files to be filtered

Returns:

an array containing the name of transformation context attributes that hold the list of files to be filtered

getConditionTemplate

public SingleCondition getConditionTemplate()

Return the single condition template to be evaluated against all files

Returns:

the single condition template to be evaluated against all files

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

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

newConditionInstance

public SingleCondition newConditionInstance(java.io.File file)

Creates a new single condition instance copying from this current object, but setting the file it should perform against based on the input parameters

Parameters:

file - the actual file to be performed against

Returns:

this transformation utility instance