com.paypal.butterfly.extensions.api.utilities.ManualInstruction 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.utilities;

import com.paypal.butterfly.extensions.api.*;
import com.paypal.butterfly.extensions.api.exception.TransformationUtilityException;

import java.io.File;
import java.net.URL;

/**
 * Registers a manual instruction, also known as "post-upgrade instruction", which can be seen as
 * a transformation operation that is too complex to be automated, but that should at least be recognized and reported by Butterfly.
 * 

 * In the end of the transformation, every manual instruction is reported in order of registration as Markdown ({@code .md}) files.
 *
 * @author facarvalho
 */
public class ManualInstruction extends TransformationUtility {

    private String description;
    private String resourceName;

    public ManualInstruction(String description, String resourceName) {
        setSaveResult(false);

        setDescription(description);
        setResourceName(resourceName);
    }

    public ManualInstruction setDescription(String description) {
        checkForBlankString("description", description);
        this.description = description;
        return this;
    }

    public ManualInstruction setResourceName(String resourceName) {
        checkForBlankString("resourceName", resourceName);
        this.resourceName = resourceName;
        return this;
    }

    @Override
    public String getDescription() {
        return description;
    }

    /**
     * Returns the instruction resource name
     *
     * @return the instruction resource name
     */
    public String getResourceName() {
        return resourceName;
    }

    @Override
    protected ExecutionResult execution(File transformedAppFolder, TransformationContext transformationContext) {
        TUExecutionResult result = null;

        URL resource = getClass().getClassLoader().getResource(resourceName);
        if (resource == null) {
            String exceptionMessage = String.format("Resource %s could not be found in the classpath", resourceName);
            TransformationUtilityException e = new TransformationUtilityException(exceptionMessage);
            result = TUExecutionResult.error(this, e);
        } else {
            ManualInstructionRecord manualInstructionRecord = new ManualInstructionRecord(getTransformationTemplate(), description, resource);
            result = TUExecutionResult.value(this, manualInstructionRecord);
        }

        return result;
    }

}