com.paypal.butterfly.extensions.api.operations

Class ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO>

java.lang.Object

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

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

com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElementTO<T>

All Implemented Interfaces:

ChangeOrRemoveElement<T>, Cloneable

public abstract class ChangeOrRemoveElementTO<T extends ChangeOrRemoveElementTO>
extends TransformationOperation<T>
implements ChangeOrRemoveElement<T>

Convenience class with ChangeOrRemoveElement implementation ready for TransformationOperation subclasses. Protected instance variable ifNotPresent can be used when deciding the result type, in case the element to be changed or removed is not present.

Author:

facarvalho

Nested Class Summary

Nested classes/interfaces inherited from interface com.paypal.butterfly.extensions.api.operations.ChangeOrRemoveElement

ChangeOrRemoveElement.IfNotPresent

Field Summary

Fields

Modifier and Type	Field and Description
protected ChangeOrRemoveElement.IfNotPresent	ifNotPresent

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

UTILITY_NAME_SYNTAX

Constructor Summary

Constructors

Constructor and Description
ChangeOrRemoveElementTO()

Method Summary

Modifier and Type	Method and Description
T	failIfNotPresent() Fail (TOExecutionResult.Type.ERROR) if the element to be changed or removed is not present
T	noOpIfNotPresent() Do nothing, not warn neither fail, (TOExecutionResult.Type.NO_OP) if the element to be changed or removed is not present
T	warnIfNotPresent() Warn (TOExecutionResult.Type.WARNING) if the element to be changed or removed is not present

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

getOrCreateReadFile, perform, setSaveResult

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, execution, getAbortionMessage, getAbsoluteFile, getContextAttributeName, getDependencies, getDescription, getIfConditionAttributeName, getName, getOrder, getParent, getRelativePath, getRelativePath, getTransformationTemplate, getUnlessConditionAttributeName, hasBeenPerformed, hashCode, hashCode, isFileSet, isSaveResult, normalizeRelativePathSeparator, relative, set, setContextAttributeName, setName, setParent, toString, wasFileExplicitlySet

Methods inherited from class java.lang.Object

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

Field Detail

ifNotPresent

protected ChangeOrRemoveElement.IfNotPresent ifNotPresent

Constructor Detail

ChangeOrRemoveElementTO

public ChangeOrRemoveElementTO()

Method Detail

failIfNotPresent

public T failIfNotPresent()

Description copied from interface: ChangeOrRemoveElement

Fail (TOExecutionResult.Type.ERROR) if the element to be changed or removed is not present

Specified by:

failIfNotPresent in interface ChangeOrRemoveElement<T extends ChangeOrRemoveElementTO>

Returns:

the transformation operation instance

warnIfNotPresent

public T warnIfNotPresent()

Description copied from interface: ChangeOrRemoveElement

Warn (TOExecutionResult.Type.WARNING) if the element to be changed or removed is not present

Specified by:

warnIfNotPresent in interface ChangeOrRemoveElement<T extends ChangeOrRemoveElementTO>

Returns:

the transformation operation instance

noOpIfNotPresent

public T noOpIfNotPresent()

Description copied from interface: ChangeOrRemoveElement

Do nothing, not warn neither fail, (TOExecutionResult.Type.NO_OP) if the element to be changed or removed is not present

Specified by:

noOpIfNotPresent in interface ChangeOrRemoveElement<T extends ChangeOrRemoveElementTO>

Returns:

the transformation operation instance