com.paypal.butterfly.extensions.api

Class PerformResult

java.lang.Object

com.paypal.butterfly.extensions.api.PerformResult

public class PerformResult
extends Object

The meta-data object resulted after the TransformationUtility instance has been performed.

Author:

facarvalho

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PerformResult.Type The type of result after the TransformationUtility instance has been performed.

Method Summary

Modifier and Type	Method and Description
R	addWarning(Exception warning) Add a new warning associated with this result.
protected void	changeTypeOnWarning() This method is used to notify subclasses that the result type might have to change due to the addition of a warning.
protected boolean	dependencyFailureCheck() Returns true if this result type falls to the dependency failure criteria, which is stated in TransformationUtility.dependsOn(String...)
static PerformResult	error(TransformationUtility transformationUtility, Exception exception) This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
static PerformResult	error(TransformationUtility transformationUtility, Exception exception, String details) This means The TU failed, but not because of its utility execution itself, but because of an internal reason.
static PerformResult	executionResult(TransformationUtility transformationUtility, ExecutionResult executionResult) This means the utility has been executed, and the result type is defined based on the utility execution result type.
String	getDetails() Return the result details
Exception	getException() Return the exception object in case of types such as ERROR
ExecutionResult	getExecutionResult() Return the ExecutionResult object associated with this perform result
S	getSource() Returns the source of this result, which could be for example a transformation utility instance or a transformation operation instance
T	getType() Returns the result type
List<Exception>	getWarnings() Return a list of warnings associated with this result.
protected boolean	isExceptionType() Returns true if this result type is supposed to contain an exception, such ERROR
R	setDetails(String details)
protected R	setException(Exception exception) Set the exception associated with this result.
protected R	setType(T type)
static PerformResult	skippedCondition(TransformationUtility transformationUtility, String details) This means the utility has not been executed because its pre-requisite condition is not true
static PerformResult	skippedDependency(TransformationUtility transformationUtility, String details) This means the utility has not been executed because one or more of its dependencies "failed".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

executionResult

public static PerformResult executionResult(TransformationUtility transformationUtility,
                                            ExecutionResult executionResult)

This means the utility has been executed, and the result type is defined based on the utility execution result type.

Parameters:

transformationUtility - the TransformationUtility object that produced this result

executionResult - the utility execution result

Returns:

the created PerformResult object of type PerformResult.Type.EXECUTION_RESULT

skippedCondition

public static PerformResult skippedCondition(TransformationUtility transformationUtility,
                                             String details)

This means the utility has not been executed because its pre-requisite condition is not true

Parameters:

transformationUtility - the TransformationUtility object that produced this result

details - details about the result

Returns:

the created PerformResult object of type PerformResult.Type.SKIPPED_DEPENDENCY

skippedDependency

public static PerformResult skippedDependency(TransformationUtility transformationUtility,
                                              String details)

This means the utility has not been executed because one or more of its dependencies "failed". See TransformationUtility.dependsOn(String...) for the dependency failure criteria definition

Parameters:

transformationUtility - the TransformationUtility object that produced this result

details - details about the result

Returns:

the created PerformResult object of type PerformResult.Type.SKIPPED_DEPENDENCY

error

public static PerformResult error(TransformationUtility transformationUtility,
                                  Exception exception,
                                  String details)

This means The TU failed, but not because of its utility execution itself, but because of an internal reason. For example, when a TransformationOperationException is thrown because the absolute file the TU should execute against could not be resolved during transformation time

Parameters:

transformationUtility - the TransformationUtility object that produced this result

exception - the exception to be registered to the result object

details - details about the result

Returns:

the created PerformResult object of type PerformResult.Type.ERROR

error

public static PerformResult error(TransformationUtility transformationUtility,
                                  Exception exception)

This means The TU failed, but not because of its utility execution itself, but because of an internal reason. For example, when a TransformationOperationException is thrown because the absolute file the TU should execute against could not be resolved during transformation time

Parameters:

transformationUtility - the TransformationUtility object that produced this result

exception - the exception to be registered to the result object

Returns:

the created PerformResult object of type PerformResult.Type.ERROR

changeTypeOnWarning

protected void changeTypeOnWarning()

This method is used to notify subclasses that the result type might have to change due to the addition of a warning.
Usually it should change from a successful type to a warning type. In case the result is an error kind of type, then it should remain as is.

getExecutionResult

public ExecutionResult getExecutionResult()

Return the ExecutionResult object associated with this perform result

Returns:

the ExecutionResult object associated with this perform result

isExceptionType

protected boolean isExceptionType()

Returns true if this result type is supposed to contain an exception, such ERROR

Returns:

true only if this result type is supposed to contain an exception

dependencyFailureCheck

protected boolean dependencyFailureCheck()

Returns true if this result type falls to the dependency failure criteria, which is stated in TransformationUtility.dependsOn(String...)

Returns:

true only if this result type falls to the dependency failure criteria

setType

protected R setType(T type)

setDetails

public R setDetails(String details)

setException

protected R setException(Exception exception)

Set the exception associated with this result. This exception can only be set if the result type allows it. If that is not the case, an IllegalArgumentException will be thrown

Parameters:

exception - associated with the execution result

Returns:

this object

addWarning

public R addWarning(Exception warning)

Add a new warning associated with this result. Warnings never imply the result is non-successful, only errors do

Parameters:

warning - the warning to be added

Returns:

this object

getSource

public S getSource()

Returns the source of this result, which could be for example a transformation utility instance or a transformation operation instance

Returns:

the source of this result

getType

public T getType()

Returns the result type

Returns:

the result type

getDetails

public String getDetails()

Return the result details

Returns:

the result details

getException

public Exception getException()

Return the exception object in case of types such as ERROR

Returns:

the exception object in case of types such as ERROR

getWarnings

public List<Exception> getWarnings()

Return a list of warnings associated with this result. Warnings never imply the result is non-successful, only errors do

Returns:

a list of warnings associated with this result