public abstract class Format
extends java.lang.Object
implements java.lang.Cloneable
By default, all parsers and writers have to handle, at least, the following format definitions:
lineSeparator
defaults to the system line separator
lineSeparator
will be replaced by this character.lineSeparator
.normalizedNewline
defaults to '\n'.
comment
defaults to '#'.
CsvFormat
,
FixedWidthFormat
Modifier and Type | Field and Description |
---|---|
private char |
comment |
private char[] |
lineSeparator |
private java.lang.String |
lineSeparatorString |
private char |
normalizedNewline |
private static char[] |
systemLineSeparator |
private static java.lang.String |
systemLineSeparatorString |
Modifier | Constructor and Description |
---|---|
protected |
Format() |
Modifier and Type | Method and Description |
---|---|
protected Format |
clone() |
char |
getComment()
Returns the character that represents a line comment.
|
protected abstract java.util.TreeMap<java.lang.String,java.lang.Object> |
getConfiguration() |
private static java.lang.String |
getFormattedValue(java.lang.Object value) |
char[] |
getLineSeparator()
Returns the current line separator character sequence, which can contain 1 to 2 characters.
|
java.lang.String |
getLineSeparatorString()
Returns the current line separator sequence as a String of 1 to 2 characters.
|
char |
getNormalizedNewline()
Returns the normalized newline character, which is automatically replaced by
lineSeparator when reading/writing. |
static char[] |
getSystemLineSeparator()
Returns the system's line separator sequence, which can contain 1 to 2 characters.
|
boolean |
isComment(char ch)
Identifies whether or not a given character represents a comment
|
boolean |
isNewLine(char ch)
Compares the given character against the
normalizedNewline character. |
void |
setComment(char comment)
Defines the character that represents a line comment when found in the beginning of a line of text.
|
void |
setLineSeparator(char[] lineSeparator)
Defines the line separator sequence that should be used for parsing and writing.
|
void |
setLineSeparator(java.lang.String lineSeparator)
Defines the line separator sequence that should be used for parsing and writing.
|
void |
setNormalizedNewline(char normalizedNewline)
Sets the normalized newline character, which is automatically replaced by
lineSeparator when reading/writing |
java.lang.String |
toString() |
private static final java.lang.String systemLineSeparatorString
private static final char[] systemLineSeparator
private java.lang.String lineSeparatorString
private char[] lineSeparator
private char normalizedNewline
private char comment
public char[] getLineSeparator()
public static char[] getSystemLineSeparator()
public java.lang.String getLineSeparatorString()
public void setLineSeparator(java.lang.String lineSeparator)
lineSeparator
- a sequence of 1 to 2 characters that identifies the end of a linepublic void setLineSeparator(char[] lineSeparator)
lineSeparator
- a sequence of 1 to 2 characters that identifies the end of a linepublic char getNormalizedNewline()
lineSeparator
when reading/writing. Defaults to '\n'.public void setNormalizedNewline(char normalizedNewline)
lineSeparator
when reading/writingnormalizedNewline
- a single character used to represent a line separator.public boolean isNewLine(char ch)
normalizedNewline
character.ch
- the character to be verifiedpublic char getComment()
Set it to '\0' to disable comment skipping.
public void setComment(char comment)
Use '\0' to disable comment skipping.
comment
- the comment characterpublic boolean isComment(char ch)
ch
- the character to be verifiedprivate static java.lang.String getFormattedValue(java.lang.Object value)
public final java.lang.String toString()
toString
in class java.lang.Object
protected abstract java.util.TreeMap<java.lang.String,java.lang.Object> getConfiguration()
protected Format clone()
clone
in class java.lang.Object