com.github.jlgrock.javascriptframework.mavenutils.io.FileIO Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-utils Show documentation
Although this is technically not a plugin, this is a bunch of tools that all of the plugins use. This is very useful for anyone doing maven plugin development.
There is a newer version: 1.18.3
Show newest version
package com.github.jlgrock.javascriptframework.mavenutils.io;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.util.Arrays;
import java.util.List;

import org.apache.commons.io.IOUtils;
import org.apache.log4j.Logger;

import com.github.jlgrock.javascriptframework.mavenutils.io.readers.FilteredReader;

/**
 * A general usage class for doing File manipulations.
 */
public final class FileIO {
	/**
	 * The Logger.
	 */
	static final Logger LOGGER = Logger.getLogger(FileIO.class);

	/**
	 * Should not use constructor for utility class.
	 */
	private FileIO() {}
	
	/**
	 * Will copy content from an inputstream to an output stream, closing the files when it has completed.
	 * 
	 * @param from The expected file to read in from
	 * @param to The expected file to write to
	 * @throws IOException if there was any issues copying the resource
	 */
	public static void copyStream(final InputStream from, final OutputStream to) throws IOException {
		LOGGER.debug("copying stream...");
		try {
		    IOUtils.copy(from, to);
		}  catch (IOException ioe) {
			LOGGER.error("There was a problem copying the resource.");
			throw ioe;
		} finally {
		    IOUtils.closeQuietly(from);
		    IOUtils.closeQuietly(to);
		}
	}

	/**
	 * Take a bunch of readers (files or otherwise) and concatenate 
	 * their input together into one output file.
	 * 
	 * @param readers the readers to concatenate together
	 * @param outputFile the output file to write to
	 * @throws IOException if any problems occur during reading, writing, or concatenation
	 */
    public void concatenateStreams(final Reader[] readers, final File outputFile) throws IOException {
    	if (outputFile == null) {
    		throw new IOException("outputFile is required for concatenation of files.");
    	}

    	LOGGER.debug("Begining stream concatenation");
    	List readerList = Arrays.asList(readers);
    	FileWriter outWriter = null;
    	
    	//create the output dir
    	DirectoryIO.createDir(outputFile.getParentFile());
    	outputFile.createNewFile();
    	
    	//create the output file
    	try {
    		outWriter = new FileWriter(outputFile);
    	
	        for (Reader listItem : readerList) {
	        	//replace tabs with 4 spaces for linting
	        	FilteredReader fr = new FilteredReader(listItem, "\t", "    ");
	        	String line;
	        	do {
		    		line = fr.readLine();
		    		if (line != null) {
		    			outWriter.append(line + "\n");
		    		}
	        	} while(line != null);
	        	listItem.close();
	        }
    	} finally {
    		try {
    			outWriter.close();
    		} catch(Exception e) {
    			LOGGER.error("Unable to close file.  This should not matter");
    		}
    	}
    }
    
    /**
     * Parses the extension of a file.
     * 
     * @param file the file to parse
     * @return the extension of the file
     */
    public static String getFileExtension(final File file) {
    	String name = file.getName();
    	int pos = name.lastIndexOf('.');
    	return name.substring(pos+1);
    }
    
    /**
     * Remove the extension from a file.
     * 
     * @param file the file to parse
     * @return the filename with the extension removed
     */
    public static String removeFileExtension(final File file) {
    	String name = file.getName();
    	if (!name.contains(".")) {
    		return name;
    	}
    	int pos = name.lastIndexOf('.');
    	return name.substring(0, pos);
    }
    
    /**
     * Change the extension of a file, based off of the period extension notation.
     * 
     * @param file the file that you would like to change the extension of
     * @param newExtension The extension that you would like to change it to
     * @throws IOException If the system is unable to rename the file
     */
    public static void changeExtension(final File file, final String newExtension) throws IOException {
    	String newFilename = removeFileExtension(file) + "." + newExtension;
    	File file2 = new File(newFilename);
    	boolean success = file.renameTo(file2);
    	if (!success) {
    		throw new IOException("Could not rename file from \"" + file.getName() + "\" to \"" + file2.getName() + "\".");
    	}
    }
}