com.puresoltechnologies.maven.plugins.license.internal

Class IOUtilities

java.lang.Object

com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

public class IOUtilities
extends Object

This class contains some utilities for the license maven plugin.

Author:

Rick-Rainer Ludwig

Field Summary

Fields

Modifier and Type	Field and Description
static String	LICENSE_RESULTS_FILE The constant for the license validation result file.
static String	LICENSE_SETTINGS_FILE This is the constant for the settings properties file.

Method Summary

Modifier and Type	Method and Description
static void	createDirectoryIfNotPresent(org.apache.maven.plugin.logging.Log log, File directory) This method checks a directory for presence.
static void	createFileIfNotPresent(org.apache.maven.plugin.logging.Log log, File file) This method checks a file for presence.
static File	createNewResultsFile(org.apache.maven.plugin.logging.Log log, File outputDirectory) Creates a new and empty results file.
static File	createNewSettingsFile(org.apache.maven.plugin.logging.Log log, File outputDirectory) Creates a new and empty settings file.
static void	deleteFileIfPresent(org.apache.maven.plugin.logging.Log log, File file) This method checks the presence of a file.
static File	getResultsFile(org.apache.maven.plugin.logging.Log log, File outputDirectory) Returns the position of the results file.
static File	getSettingsFile(org.apache.maven.plugin.logging.Log log, File outputDirectory) This method checks and returns the position of the settings file.
static ValidationResult	readResult(BufferedReader bufferedReader) Reads a single CSV line from a BufferedReader and converts it into a ValidationResult.
static <T> T	restoreObject(File file) This method returns a former serialized object from a file.
protected static String[]	split(String line) This method splits a single CSV line into junks of String.
static void	storeObject(File file, Serializable object) Stores any Serializable object into a file.
static void	writeResult(Writer writer, ValidationResult validationResult) Writes a CSV file line with the given ValidationResult.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LICENSE_RESULTS_FILE

public static final String LICENSE_RESULTS_FILE

The constant for the license validation result file.

See Also:

Constant Field Values

LICENSE_SETTINGS_FILE

public static final String LICENSE_SETTINGS_FILE

This is the constant for the settings properties file.

See Also:

Constant Field Values

Method Detail

createNewResultsFile

public static File createNewResultsFile(org.apache.maven.plugin.logging.Log log,
                                        File outputDirectory)
                                 throws org.apache.maven.plugin.MojoExecutionException

Creates a new and empty results file.

Parameters:

log - is the Log to write to.

outputDirectory - is the directory for the output file.

Returns:

A File object is returned pointing to the newly created results file.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown in case the file could not be created.

getResultsFile

public static File getResultsFile(org.apache.maven.plugin.logging.Log log,
                                  File outputDirectory)
                           throws org.apache.maven.plugin.MojoExecutionException

Returns the position of the results file.

Parameters:

log - is the Log to write to.

outputDirectory - is the directory for the output file.

Returns:

A File object is returned pointing to the results file.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown if no file is found.

createNewSettingsFile

public static File createNewSettingsFile(org.apache.maven.plugin.logging.Log log,
                                         File outputDirectory)
                                  throws org.apache.maven.plugin.MojoExecutionException

Creates a new and empty settings file.

Parameters:

log - is the Log to write to.

outputDirectory - is the directory for the output file.

Returns:

A File object is returned pointing to the newly created settings file.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown in case the file could not be created.

getSettingsFile

public static File getSettingsFile(org.apache.maven.plugin.logging.Log log,
                                   File outputDirectory)
                            throws org.apache.maven.plugin.MojoExecutionException

This method checks and returns the position of the settings file.

Parameters:

log - is the Log to write to.

outputDirectory - is the directory for the output file.

Returns:

A File object is returned pointing to the settings file.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown in case the file could not be found.

createDirectoryIfNotPresent

public static void createDirectoryIfNotPresent(org.apache.maven.plugin.logging.Log log,
                                               File directory)
                                        throws org.apache.maven.plugin.MojoExecutionException

This method checks a directory for presence. If it is not existing, it will be created.

Parameters:

log - is the Log to write to.

directory - is the directory to be checked and created if needed.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown if the directory is not present and could not be created.

createFileIfNotPresent

public static void createFileIfNotPresent(org.apache.maven.plugin.logging.Log log,
                                          File file)
                                   throws org.apache.maven.plugin.MojoExecutionException

This method checks a file for presence. If it is not existing, it will be created.

Parameters:

log - is the Log to write to.

file - is the directory to be checked and created if needed.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown if the directory is not present and could not be created.

deleteFileIfPresent

public static void deleteFileIfPresent(org.apache.maven.plugin.logging.Log log,
                                       File file)
                                throws org.apache.maven.plugin.MojoExecutionException

This method checks the presence of a file. If it is present, it is deleted.

Parameters:

log - is the Maven logger Log.

file - is the files to be deleted if present.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown in cases of IO issues.

writeResult

public static void writeResult(Writer writer,
                               ValidationResult validationResult)
                        throws org.apache.maven.plugin.MojoExecutionException

Writes a CSV file line with the given ValidationResult.

Parameters:

writer - is the Writer to write to.

validationResult - is the ValidationResult object which is to be written to the writer.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown in cases of IO issues.

readResult

public static ValidationResult readResult(BufferedReader bufferedReader)
                                   throws org.apache.maven.plugin.MojoExecutionException

Reads a single CSV line from a BufferedReader and converts it into a ValidationResult.

Parameters:

bufferedReader - is the BufferedReader to read from.

Returns:

A ValidationResult is returned containing the read information.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown in case of IO issues.

split

protected static String[] split(String line)

This method splits a single CSV line into junks of String.

Parameters:

line - is the line to be split.

Returns:

An array of String is returned.

storeObject

public static void storeObject(File file,
                               Serializable object)
                        throws IOException

Stores any Serializable object into a file.

Parameters:

file - is the file where the object is to be stored to.

object - is the objec which is to be stored.

Throws:

IOException - is thrown in cases of IO issues.

restoreObject

public static <T> T restoreObject(File file)
                           throws IOException

This method returns a former serialized object from a file.

Type Parameters:

T - is the actual type of the object read from the file.

Parameters:

file - is the file to read the object from.

Returns:

An object T is returned which was read form the file.

Throws:

IOException - is thrown in cases of IO issues.