com.paypal.butterfly.extensions.api.utilities

Class Log

java.lang.Object

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

com.paypal.butterfly.extensions.api.utilities.Log

All Implemented Interfaces:

java.lang.Cloneable

public class Log
extends TransformationUtility<Log>

Provides logging statements during transformation time. Since all it does is logging, it always returns TUExecutionResult.Type.NULL as result of execution.
If no log level is defined, then it will be set to INFO, except when there is only one attribute and it is null. In this case it will be set to WARNING.

Field Summary

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

UTILITY_NAME_SYNTAX

Constructor Summary

Constructors

Constructor and Description
Log() Utility to provide logging statements during transformation time.

Method Summary

Modifier and Type	Method and Description
protected TUExecutionResult	execution(java.io.File transformedAppFolder, TransformationContext transformationContext) The implementation execution of this transformation utility.
java.lang.String[]	getAttributeNames() Returns a copy of the array containing all attribute names used by this Log 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.
org.slf4j.event.Level	getLogLevel() Returns the log level
java.lang.String	getLogMessage() Returns the log message
Log	setAttributeNames(java.lang.String... attributeNames) Sets names of transformation context attributes to be used as arguments for this log statement
Log	setLogLevel(org.slf4j.event.Level logLevel) Sets the log level
Log	setLogMessage(java.lang.String logMessage) Sets the log message

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

Log

public Log()

Utility to provide logging statements during transformation time. Since all it does is logging, it returns as result of execution the log message

Method Detail

setLogLevel

public Log setLogLevel(org.slf4j.event.Level logLevel)

Sets the log level

Parameters:

logLevel - log level

Returns:

this transformation utility object

setLogMessage

public Log setLogMessage(java.lang.String logMessage)

Sets the log message

Parameters:

logMessage - log message

Returns:

this transformation utility object

getLogLevel

public org.slf4j.event.Level getLogLevel()

Returns the log level

Returns:

the log level

getLogMessage

public java.lang.String getLogMessage()

Returns the log message

Returns:

the log message

getAttributeNames

public java.lang.String[] getAttributeNames()

Returns a copy of the array containing all attribute names used by this Log transformation utility. Returns null if there are no attributes.

Returns:

all attribute names used by this Log transformation utility

setAttributeNames

public Log setAttributeNames(java.lang.String... attributeNames)

Sets names of transformation context attributes to be used as arguments for this log statement

Parameters:

attributeNames - names of transformation context attributes to be used as arguments for this log statement

Returns:

this transformation utility object

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

Returns:

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

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

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