com.coderplus.plugins.RenameMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of copy-rename-maven-plugin Show documentation
This plugin helps in copying files or renaming files or directories during the Maven build lifecycle.
The newest version!
package com.coderplus.plugins;

/*
 * The MIT License
 *
 * Copyright (c) 2014
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import java.io.File;
import java.io.IOException;
import java.util.List;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.sonatype.plexus.build.incremental.BuildContext;
import org.codehaus.plexus.util.FileUtils;


/**
 * Rename files or directories during build.
 * 
 * @author Aneesh Joseph
 * @since 1.0
 */
@Mojo( name = "rename", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true )
public class RenameMojo
extends AbstractMojo
{
	/**
	 * The file/directory which has to be renamed
	 * 
	 * @since 1.0
	 */
	@Parameter( required = false )
	private File sourceFile;
	/**
	 * The target file/directory name
	 * 
	 * @since 1.0
	 */
	@Parameter( required = false )
	private File destinationFile;

	/**
	 * Collection of FileSets to work on (FileSet contains sourceFile and destinationFile). See Usage for details.
	 * 
	 * @since 1.0
	 */
	@Parameter( required = false )
	private List fileSets;

	/**
	 * Ignore File Not Found errors during incremental build
	 *
	 * @since 1.0
	 */
	@Parameter( property = "copy.overWrite", defaultValue = "true" )
	boolean overWrite;

	/**
	 * Ignore errors if the source file/directory was not found during incremental build
	 *
	 * @since 1.0
	 */
	@Parameter( property = "copy.ignoreFileNotFoundOnIncremental", defaultValue = "true" )
	boolean ignoreFileNotFoundOnIncremental;


	/**
	 * @since 1.0
	 */
	@Component
	private MavenProject project;

	@Component
	private BuildContext buildContext;

	public void execute() throws MojoExecutionException
	{
		getLog().debug("Executing the copy-rename-maven-plugin");
		if(fileSets!= null && fileSets.size() > 0){
			for(FileSet fileSet: fileSets){
				File srcFile = fileSet.getSourceFile();
				File destFile = fileSet.getDestinationFile();
				if(srcFile!=null){
					copy(srcFile,destFile);
				}
			}
		} else if(sourceFile!= null){
			copy(sourceFile,destinationFile);
		} else{
			getLog().info("No Files to process");
		}
	}

	private void copy(File srcFile,File destFile) throws MojoExecutionException{

		if(!srcFile.exists()){
			if(ignoreFileNotFoundOnIncremental && buildContext.isIncremental()){
				getLog().warn("sourceFile "+srcFile.getAbsolutePath()+ " not found during incremental build");
			} else {
				throw new MojoExecutionException("sourceFile "+srcFile.getAbsolutePath()+ " does not exist");
			}
		}  else if(destFile == null){
			throw new MojoExecutionException("destinationFile not specified");
		} else if(destFile.exists() && (destFile.isFile() == srcFile.isFile()) && !overWrite){
			throw new MojoExecutionException(destFile.getAbsolutePath()+" already exists and overWrite not set");
		} else{
			try {
				FileUtils.rename(srcFile, destFile);
				getLog().info("Renamed "+ srcFile.getAbsolutePath()+ " to "+ destFile.getAbsolutePath());
				buildContext.refresh(destFile);
			} catch (IOException e) {
				throw new MojoExecutionException("could not rename "+srcFile.getAbsolutePath()+" to "+destFile.getAbsolutePath());
			}
		}


	}
}