Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.paypal.butterfly.extensions.api;
/**
* The meta-data object resulted after the {@link TransformationUtility} instance has been performed.
*
* @author facarvalho
*/
public class PerformResult extends Result {
/**
* The type of result after the {@link TransformationUtility} instance has been performed.
*/
public enum Type {
/**
* The result type is defined based on the utility execution result type.
*/
EXECUTION_RESULT,
/**
* The TU has a condition associated with it ({@link TransformationUtility#executeIf(String)}) but that condition resulted in {@code false}.
*/
SKIPPED_CONDITION,
/**
* The TU depends on one or more TUs, and at least one of them didn't result in SUCCESS.
*/
SKIPPED_DEPENDENCY,
/**
* The TU failed, but not because of its utility execution itself, but because of an internal reason.
* For example, when a {@code TransformationUtilityException} is thrown because the absolute file
* the TU should execute against could not be resolved during transformation time.
*/
ERROR
}
// The utility execution result, in case
// type is EXECUTION_RESULT
private ExecutionResult executionResult = null;
/*
* This means the utility has been executed,
* and the result type is defined based on the utility execution result type.
*
* @param executionResult the utility execution result
*/
private PerformResult(TransformationUtility transformationUtility, ExecutionResult executionResult) {
super(transformationUtility, Type.EXECUTION_RESULT);
if(executionResult == null) {
throw new IllegalArgumentException("Execution result cannot be blank");
}
setDetails(executionResult.getDetails());
this.executionResult = executionResult;
}
private PerformResult(TransformationUtility transformationUtility, Type type) {
super(transformationUtility, type);
}
private PerformResult(TransformationUtility transformationUtility, Type type, String details) {
super(transformationUtility, type);
setDetails(details);
}
/**
* This means the utility has been executed,
* and the result type is defined based on the utility execution result type.
*
* @param transformationUtility the {@link TransformationUtility} object that produced this result
* @param executionResult the utility execution result
* @return the created {@link PerformResult} object of type {@link Type#EXECUTION_RESULT}
*/
public static PerformResult executionResult(TransformationUtility transformationUtility, ExecutionResult executionResult) {
return new PerformResult(transformationUtility, executionResult);
}
/**
* This means the utility has not been executed
* because its pre-requisite condition is not true
*
* @param transformationUtility the {@link TransformationUtility} object that produced this result
* @param details details about the result
* @return the created {@link PerformResult} object of type {@link Type#SKIPPED_DEPENDENCY}
*/
public static PerformResult skippedCondition(TransformationUtility transformationUtility, String details) {
PerformResult result = new PerformResult(transformationUtility, Type.SKIPPED_CONDITION, details);
// TODO should it hold the name of the transformation context attribute separately from the details?
// Maybe not, because the utility itself has that already
return result;
}
/**
* This means the utility has not been executed because one or more
* of its dependencies "failed". See {@link TransformationUtility#dependsOn(String...)}
* for the dependency failure criteria definition
*
* @param transformationUtility the {@link TransformationUtility} object that produced this result
* @param details details about the result
* @return the created {@link PerformResult} object of type {@link Type#SKIPPED_DEPENDENCY}
*/
public static PerformResult skippedDependency(TransformationUtility transformationUtility, String details) {
PerformResult result = new PerformResult(transformationUtility, Type.SKIPPED_DEPENDENCY, details);
// TODO should it hold the name(s) of the dependent transformation utility(s) separately from the details?
// Maybe not, because the utility itself has that already
return result;
}
/**
* 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
*
* @param transformationUtility the {@link TransformationUtility} object that produced this result
* @param exception the exception to be registered to the result object
* @param details details about the result
* @return the created {@link PerformResult} object of type {@link Type#ERROR}
*/
public static PerformResult error(TransformationUtility transformationUtility, Exception exception, String details) {
PerformResult result = new PerformResult(transformationUtility, Type.ERROR, details);
result.setException(exception);
return result;
}
/**
* 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
*
* @param transformationUtility the {@link TransformationUtility} object that produced this result
* @param exception the exception to be registered to the result object
* @return the created {@link PerformResult} object of type {@link Type#ERROR}
*/
public static PerformResult error(TransformationUtility transformationUtility, Exception exception) {
PerformResult result = new PerformResult(transformationUtility, Type.ERROR);
result.setException(exception);
return result;
}
@Override
protected void changeTypeOnWarning() {
// Nothing do be done here, since warnings do not apply to this type of result
}
/**
* Return the {@link ExecutionResult} object associated with this perform result
*
* @return the {@link ExecutionResult} object associated with this perform result
*/
public ExecutionResult getExecutionResult() {
return executionResult;
}
@Override
protected boolean isExceptionType() {
switch (getType()) {
case SKIPPED_CONDITION:
case SKIPPED_DEPENDENCY:
return false;
case ERROR:
return true;
case EXECUTION_RESULT:
default:
return executionResult.isExceptionType();
}
}
@Override
protected boolean dependencyFailureCheck() {
switch (getType()) {
case SKIPPED_CONDITION:
case SKIPPED_DEPENDENCY:
case ERROR:
return true;
case EXECUTION_RESULT:
default:
return executionResult.dependencyFailureCheck();
}
}
}
