com.paypal.butterfly.utilities.operations.file.DeleteFile Maven / Gradle / Ivy

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

import com.paypal.butterfly.extensions.api.TOExecutionResult;
import com.paypal.butterfly.extensions.api.TransformationContext;
import com.paypal.butterfly.extensions.api.TransformationOperation;
import com.paypal.butterfly.extensions.api.exception.TransformationOperationException;
import com.paypal.butterfly.extensions.api.exception.TransformationUtilityException;
import org.apache.commons.io.FileUtils;

import java.io.File;
import java.io.IOException;

/**
 * Deletes a single file or folder (empty or not).
 * If the specified file does not exist, the result will be a {@link TOExecutionResult.Type#NO_OP}.
 *
 * @author facarvalho
 */
public class DeleteFile extends TransformationOperation {

    private static final String DESCRIPTION = "Delete file %s";

    // Even though it is redundant to have this default constructor here, since it is
    // the only one (the compiler would have added it implicitly), this is being explicitly
    // set here to emphasize that the public default constructor should always be
    // available by any transformation utility even when additional constructors are present.
    // The reason for that is the fact that one or more of its properties might be set
    // during transformation time, using the TransformationUtility set method
    @SuppressWarnings("PMD.UnnecessaryConstructor")
    /**
     * Deletes a single file or folder (empty or not).
     * If the specified file does not exist, the result will be a {@link TOExecutionResult.Type#NO_OP}.
     */
    public DeleteFile() {
    }

    @Override
    public String getDescription() {
        return String.format(DESCRIPTION, getRelativePath());
    }

    @Override
    protected TOExecutionResult execution(File transformedAppFolder, TransformationContext transformationContext) {
        File fileToBeRemoved;
        try {
            fileToBeRemoved = getAbsoluteFile(transformedAppFolder, transformationContext);
        } catch (TransformationUtilityException e) {
            // TODO
            // This error should be done automatically for every TO in the TransformationOperation class
            TransformationOperationException toe = new TransformationOperationException("No file has been removed because the file path has not been resolved");
            return TOExecutionResult.error(this, toe);
        }
        if(!fileToBeRemoved.exists()) {
            String result = String.format("File '%s' was not removed because it does not exist", getRelativePath());
            return TOExecutionResult.noOp(this, result);
        }

        TOExecutionResult result;
        try {
            boolean isDirectory = fileToBeRemoved.isDirectory();
            FileUtils.forceDelete(fileToBeRemoved);
            String details = String.format("%s '%s' has been removed", (isDirectory ? "Folder" : "File"), getRelativePath());
            result = TOExecutionResult.success(this, details);
        } catch (IOException e) {
            result = TOExecutionResult.error(this, e);
        }

        return result;
    }

}