com.paypal.butterfly.extensions.api.utilities

Class MapValue

java.lang.Object

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

com.paypal.butterfly.extensions.api.utilities.MapValue

All Implemented Interfaces:

java.lang.Cloneable

public class MapValue
extends TransformationUtility<MapValue>

Obtains a specific entry from a Map object stored in the TransformationContext, and store its value as a new attribute in the transformation context. The name of the transformation context attribute that holds the map object, and the key used to get the map entry, have to be specified.
The new attribute saved into the transformation context is named based on the utility name, unless TransformationUtility.setContextAttributeName(String) is called, as usual, nothing new here.

Field Summary

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

UTILITY_NAME_SYNTAX

Constructor Summary

Constructors

Constructor and Description
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(java.lang.String mapName, java.lang.Object key) 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.

Method Summary

Modifier and Type	Method and Description
protected ExecutionResult	execution(java.io.File transformedAppFolder, TransformationContext transformationContext) The implementation execution of this transformation utility.
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.Object	getKey() Returns he key used to get the map entry
java.lang.String	getMapName() Return the name of the transformation context attribute that holds the map object
MapValue	setKey(java.lang.Object key) Set the key used to get the map entry
MapValue	setMapName(java.lang.String mapName) Set the name of the transformation context attribute that holds the map object

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MapValue

public 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. The name of the transformation context attribute that holds the map object, and the key used to get the map entry, have to be specified.
The new attribute saved into the transformation context is named based on the utility name, unless TransformationUtility.setContextAttributeName(String) is called, as usual, nothing new here.

MapValue

public MapValue(java.lang.String mapName,
                java.lang.Object key)

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. The name of the transformation context attribute that holds the map object, and the key used to get the map entry, have to be specified.
The new attribute saved into the transformation context is named based on the utility name, unless TransformationUtility.setContextAttributeName(String) is called, as usual, nothing new here.

Parameters:

mapName - the name of the transformation context attribute that holds the map object

key - the key used to get the map entry

Method Detail

setMapName

public MapValue setMapName(java.lang.String mapName)

Set the name of the transformation context attribute that holds the map object

Parameters:

mapName - the name of the transformation context attribute that holds the map object

Returns:

this utility instance

setKey

public MapValue setKey(java.lang.Object key)

Set the key used to get the map entry

Parameters:

key - the key used to get the map entry

Returns:

this utility instance

getMapName

public java.lang.String getMapName()

Return the name of the transformation context attribute that holds the map object

Returns:

the name of the transformation context attribute that holds the map object

getKey

public java.lang.Object getKey()

Returns he key used to get the map entry

Returns:

the key used to get the map entry

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

Returns:

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

execution

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

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