com.paypal.butterfly.extensions.api.TUExecutionResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of butterfly-extensions-api Show documentation
null
There is a newer version: 3.2.7
Show newest version
package com.paypal.butterfly.extensions.api;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * The meta-data object resulted after the {@link TransformationUtility} instance has been executed.
 *
 * @see TUExecutionResult
 *
 * @author facarvalho
 */
public class TUExecutionResult extends ExecutionResult {

    private static final Logger logger = LoggerFactory.getLogger(TUExecutionResult.class);

    /**
     * The type of result after the {@link TransformationUtility} instance has been executed.
     */
    public enum Type {
        // No error happened, but for some reason the TU didn't result in any value (for example, when it was supposed to
        // find a specific file based on its name, but none was found)
        NULL,

        // The TU executed normally and it resulted in a value to be shared via the transformation context
        VALUE,

        // The TU executed, a "non-fatal" unexpected situation happened, and it resulted in a still valid value, or null
        // Warning types might have exceptions associated with it or not
        WARNING,

        // The TU failed to execute and resulted in no value, or in an invalid one to be discarded
        ERROR,
    }

    // The value returned by the transformation utility, which can be null
    private Object value = null;

    /**
     * A {@link Type#NULL} type of transformation utility result
     */
    private TUExecutionResult(TransformationUtility transformationUtility) {
        super(transformationUtility, Type.NULL);
    }

    /**
     * A {@link Type#VALUE} type of transformation utility result.
     * The value object must not be null.
     */
    private TUExecutionResult(TransformationUtility transformationUtility, Object value) {
        super(transformationUtility, Type.VALUE);
        setValue(value);
    }

    /**
     * A flexible constructor
     */
    private TUExecutionResult(TransformationUtility transformationUtility, Type type) {
        super(transformationUtility, type);
    }

    /**
     * A {@link Type#ERROR} type of transformation utility result
     */
    private TUExecutionResult(TransformationUtility transformationUtility, Exception exception) {
        super(transformationUtility, Type.ERROR);
        setException(exception);
    }

    public static TUExecutionResult nullResult(TransformationUtility transformationUtility) {
        return new TUExecutionResult(transformationUtility);
    }

    public static TUExecutionResult nullResult(TransformationUtility transformationUtility, String details) {
        return new TUExecutionResult(transformationUtility).setDetails(details);
    }

    public static TUExecutionResult value(TransformationUtility transformationUtility, Object value) {
        return new TUExecutionResult(transformationUtility, value);
    }

    public static TUExecutionResult value(TransformationUtility transformationUtility, String details, Object value) {
        return new TUExecutionResult(transformationUtility, value).setDetails(details);
    }

    public static TUExecutionResult warning(TransformationUtility transformationUtility, String details, Object value) {
        return new TUExecutionResult(transformationUtility, Type.WARNING).setValue(value).setDetails(details);
    }

    public static TUExecutionResult warning(TransformationUtility transformationUtility, Exception exception, Object value) {
        return new TUExecutionResult(transformationUtility, Type.WARNING).setValue(value).addWarning(exception);
    }

    public static TUExecutionResult warning(TransformationUtility transformationUtility, Exception exception, String details, Object value) {
        return new TUExecutionResult(transformationUtility, Type.WARNING).setValue(value).addWarning(exception).setDetails(details);
    }

    public static TUExecutionResult error(TransformationUtility transformationUtility, Exception exception) {
        return new TUExecutionResult(transformationUtility, exception);
    }

    public static TUExecutionResult error(TransformationUtility transformationUtility, Exception exception, Object value) {
        return new TUExecutionResult(transformationUtility, exception).setValue(value);
    }

    public static TUExecutionResult error(TransformationUtility transformationUtility, Object value, Exception exception, String details) {
        return new TUExecutionResult(transformationUtility, exception).setDetails(details).setValue(value);
    }

    private TUExecutionResult setValue(Object value) {
        if(value == null && getType().equals(Type.VALUE)) {
            setType(Type.NULL);
            logger.warn("TU result object for {} has been changed from VALUE to NULL, since its value object is null", getSource().getName());
        }
        this.value = value;
        return this;
    }

    @Override
    protected void changeTypeOnWarning() {
        if(getType().equals(Type.NULL) || getType().equals(Type.VALUE)) {
            setType(Type.WARNING);
        }
    }

    /**
     * Returns the value returned by the transformation utility, which can be null
     *
     * @return the value returned by the transformation utility, which can be null
     */
    public Object getValue() {
        return value;
    }

    @Override
    protected boolean isExceptionType() {
        return getType().equals(Type.ERROR) || getType().equals(Type.WARNING);
    }

    @Override
    protected boolean dependencyFailureCheck() {
        return getType().equals(Type.NULL) || getType().equals(Type.ERROR);
    }

}