org.conqat.lib.commons.string

Enum ENewline

java.lang.Object

java.lang.Enum<ENewline>

org.conqat.lib.commons.string.ENewline

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ENewline>

public enum ENewline
extends java.lang.Enum<ENewline>

Enumeration of newline types. This deals only with the most common subset of new line types. For more details see http://en.wikipedia.org/wiki/Newline.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAC MAC up to version 9 uses CR.
UNIX Unix (and Linux) are using LF.
WINDOWS Windows uses CR+LF.

Method Summary

Modifier and Type	Method and Description
java.lang.String	convertNewlines(java.lang.String input) Converts the input string to using the specified line breaks and returns the result.
java.lang.String	getNewline() Returns character(s) used to represent newline.
static ENewline	guessNewline(java.lang.String string) Attempts to guess the newline style from a string.
static ENewline	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ENewline[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNIX

public static final ENewline UNIX

Unix (and Linux) are using LF.

WINDOWS

public static final ENewline WINDOWS

Windows uses CR+LF.

MAC

public static final ENewline MAC

MAC up to version 9 uses CR. MacOS X uses UNIX newlines.

Method Detail

values

public static ENewline[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ENewline c : ENewline.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ENewline valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNewline

public java.lang.String getNewline()

Returns character(s) used to represent newline.

convertNewlines

public java.lang.String convertNewlines(java.lang.String input)

Converts the input string to using the specified line breaks and returns the result.

guessNewline

public static ENewline guessNewline(java.lang.String string)

Attempts to guess the newline style from a string. This performs a simple majority guess, where CR+lF are simply assumed to be next to each other. If no line breaks are found, the newline for StringUtils.LINE_SEPARATOR is returned.