Package org.apache.maven.plugins.assembly.utils

Class LineEndingsUtils

java.lang.Object

org.apache.maven.plugins.assembly.utils.LineEndingsUtils

public final class LineEndingsUtils
extends Object

Line Ending class which contains convenience methods to change line endings.

Method Summary

Modifier and Type	Method	Description
static void	convertLineEndings(File source, File dest, LineEndings lineEndings, Boolean atEndOfFile, String encoding)	Converts the line endings of a file, writing a new file.
static LineEndings	getLineEnding(String lineEnding)
static String	getLineEndingCharacters(String lineEnding)	Returns the appopriate line ending characters for the specified style
static InputStream	lineEndingConverter(InputStream in, LineEndings lineEndings)	Converts the line endings of a file, writing a new file.

Methods inherited from class java.lang.Object

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

Method Detail

convertLineEndings

public static void convertLineEndings(File source,
                                      File dest,
                                      LineEndings lineEndings,
                                      Boolean atEndOfFile,
                                      String encoding)
                               throws IOException

Converts the line endings of a file, writing a new file. The encoding of reading and writing can be specified.

Parameters:

source - The source file, not null

dest - The destination file, not null

lineEndings - This is the result of the getLineEndingChars(..) method in this utility class; the actual line-ending characters, not null.

atEndOfFile - The end-of-file line ending, if true then the resulting file will have a new line at the end even if the input didn't have one, if false then the resulting file will have no new line at the end even if the input did have one, null to determine whether to have a new line at the end of the file based on the input file

encoding - The encoding to use, null for platform encoding

Throws:

IOException - .

lineEndingConverter

public static InputStream lineEndingConverter(InputStream in,
                                              LineEndings lineEndings)
                                       throws IOException

Converts the line endings of a file, writing a new file. The encoding of reading and writing can be specified.

Parameters:

in - The source reader

lineEndings - This is the result of the getLineEndingChars(..) method in this utility class; the actual line-ending characters, not null.

Returns:

an input stream that enforces a specifi line ending style

Throws:

IOException

getLineEnding

public static LineEndings getLineEnding(String lineEnding)
                                 throws AssemblyFormattingException

Throws:

AssemblyFormattingException

getLineEndingCharacters

public static String getLineEndingCharacters(String lineEnding)
                                      throws AssemblyFormattingException

Returns the appopriate line ending characters for the specified style

Parameters:

lineEnding - The name of the line ending style, see org.apache.maven.plugin.assembly.utils.LineEndings#valueOf

Returns:

The proper line ending characters

Throws:

AssemblyFormattingException