com.paypal.butterfly.extensions.api

Class ContextAttributeRetriever<T>

java.lang.Object

com.paypal.butterfly.extensions.api.TransformationUtility

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

All Implemented Interfaces:

Cloneable

public class ContextAttributeRetriever<T>
extends TransformationUtility

Transformation utility to fetch transformation context attributes post transformation time, since they are always set during transformation time.
An example of usage of this feature would be implementing TransformationTemplate.getApplicationName(). The application name mostly will only be known after the transformation has began, but it might be necessary to know it outside of transformation time (after it). For example, the metrics system needs to know it, as seen in TransformationMetrics.getApplicationName().

Author:

facarvalho

Field Summary

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

UTILITY_NAME_SYNTAX

Constructor Summary

Constructors

Constructor and Description
ContextAttributeRetriever()
ContextAttributeRetriever(String attributeName)

Method Summary

Modifier and Type	Method and Description
protected ExecutionResult	execution(File transformedAppFolder, TransformationContext transformationContext) The implementation execution of this transformation utility.
T	getAttributeValue() Returns the value of the transformation context attribute specified earlier.
String	getDescription() Returns a short one line, but SPECIFIC, description about the transformation utility, including mentioning the files and/or folders to be manipulated.
void	setAttributeName(String attributeName)

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

ContextAttributeRetriever

public ContextAttributeRetriever()

ContextAttributeRetriever

public ContextAttributeRetriever(String attributeName)

Method Detail

setAttributeName

public void setAttributeName(String attributeName)

getDescription

public 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

Returns:

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

execution

protected ExecutionResult 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

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

getAttributeValue

public T getAttributeValue()

Returns the value of the transformation context attribute specified earlier. If the attribute value is null, null is returned. If this method is called prior to the execution of this transformation utility, an IllegalStateException is thrown.

Returns:

the value of the transformation context attribute specified earlier