org.apache.commons.release.plugin.SharedFunctions Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.release.plugin;
import java.io.File;
import java.io.IOException;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.codehaus.plexus.util.FileUtils;
/**
* Shared static functions for all of our Mojos.
*
* @author chtompki
* @since 1.0
*/
public final class SharedFunctions {
/**
* I want a buffer that is an array with 1024 elements of bytes. We declare
* the constant here for the sake of making the code more readable.
*/
public static final int BUFFER_BYTE_SIZE = 1024;
/**
* Making the constructor private because the class only contains static methods.
*/
private SharedFunctions() {
// Utility Class
}
/**
* Cleans and then initializes an empty directory that is given by the workingDirectory
* parameter.
*
* @param log is the Maven log for output logging, particularly in regards to error management.
* @param workingDirectory is a {@link File} that represents the directory to first attempt to delete then create.
* @throws MojoExecutionException when an {@link IOException} or {@link NullPointerException} is caught for the
* purpose of bubbling the exception up to Maven properly.
*/
public static void initDirectory(Log log, File workingDirectory) throws MojoExecutionException {
if (workingDirectory.exists()) {
try {
FileUtils.deleteDirectory(workingDirectory);
} catch (IOException | NullPointerException e) {
final String message = String.format("Unable to remove directory %s: %s", workingDirectory,
e.getMessage());
log.error(message);
throw new MojoExecutionException(message, e);
}
}
if (!workingDirectory.exists()) {
workingDirectory.mkdirs();
}
}
/**
* Copies a {@link File} from the fromFile to the toFile and logs the failure
* using the Maven {@link Log}.
*
* @param log the {@link Log}, the maven logger.
* @param fromFile the {@link File} from which to copy.
* @param toFile the {@link File} to which to copy into.
* @throws MojoExecutionException if an {@link IOException} or {@link NullPointerException} is caught.
*/
public static void copyFile(Log log, File fromFile, File toFile) throws MojoExecutionException {
try {
FileUtils.copyFile(fromFile, toFile);
} catch (IOException | NullPointerException e) {
final String message = String.format("Unable to copy file %s tp %s: %s", fromFile, toFile, e.getMessage());
log.error(message);
throw new MojoExecutionException(message, e);
}
}
}