org.beanio.stream.delimited
Class DelimitedReaderConfiguration

java.lang.Object
  org.beanio.stream.delimited.DelimitedReaderConfiguration

Direct Known Subclasses:

DelimitedReaderFactory

public class DelimitedReaderConfiguration
extends Object

Stores configuration settings for a DelimitedReader.

Since:

1.2

Author:

Kevin Seim

See Also:

DelimitedReader

Constructor Summary

DelimitedReaderConfiguration()
Constructs a new DelimitedReaderConfiguration.

DelimitedReaderConfiguration(char delimiter)
Constructs a new DelimitedReaderConfiguration.

Method Summary

String[]	getComments() Returns the array of comment prefixes.
char	getDelimiter() Returns the field delimiting character.
Character	getEscape() Returns the character used by the input stream to escape delimiters and itself.
Character	getLineContinuationCharacter() Returns the line continuation character or null if line continuation is disabled.
Character	getRecordTerminator() Returns the character used to mark the end of a record.
boolean	isCommentEnabled() Returns whether one or more comment prefixes have been configured.
boolean	isEscapeEnabled() Returns whether an escape character is enabled.
boolean	isLineContinationEnabled() Returns whether the line continuation character is enabled.
void	setComments(String[] comments) Sets the array of comment prefixes.
void	setDelimiter(char delimiter) Sets the field delimiting character to use.
void	setEscape(Character escapeCharacter) Sets the character used by the input stream to escape delimiters and itself.
void	setLineContinuationCharacter(Character lineContinuationCharacter) Sets the line continuation character.
void	setRecordTerminator(Character recordTerminator) Sets the character used to mark the end of a record.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelimitedReaderConfiguration

public DelimitedReaderConfiguration()

Constructs a new DelimitedReaderConfiguration.

DelimitedReaderConfiguration

public DelimitedReaderConfiguration(char delimiter)

Constructs a new DelimitedReaderConfiguration.

Parameters:

delimiter - the field delimiting character

Method Detail

getDelimiter

public char getDelimiter()

Returns the field delimiting character. Defaults to tab.

Returns:

the record delimiter

setDelimiter

public void setDelimiter(char delimiter)

Sets the field delimiting character to use.

Parameters:

delimiter - the record delimiting character

getEscape

public Character getEscape()

Returns the character used by the input stream to escape delimiters and itself. By default, escaping is disabled.

Returns:

the escape character or null if escaping is disabled

setEscape

public void setEscape(Character escapeCharacter)

Sets the character used by the input stream to escape delimiters and itself. If set to null, escaping is disabled.

Parameters:

escapeCharacter - the new escape character

getLineContinuationCharacter

public Character getLineContinuationCharacter()

Returns the line continuation character or null if line continuation is disabled. By default, line continuation is disabled.

Returns:

the line continuation character or null if disabled

setLineContinuationCharacter

public void setLineContinuationCharacter(Character lineContinuationCharacter)

Sets the line continuation character. May be set to null to disable line continuation.

Parameters:

lineContinuationCharacter - the line continuation character

isEscapeEnabled

public boolean isEscapeEnabled()

Returns whether an escape character is enabled.

Returns:

true if enabled, false otherwise

isLineContinationEnabled

public boolean isLineContinationEnabled()

Returns whether the line continuation character is enabled.

Returns:

true if the line continuation character is enabled

getRecordTerminator

public Character getRecordTerminator()

Returns the character used to mark the end of a record. By default, a carriage return (CR), line feed (LF), or CRLF sequence is used to signify the end of the record.

Returns:

the record termination character

setRecordTerminator

public void setRecordTerminator(Character recordTerminator)

Sets the character used to mark the end of a record. If set to null, a carriage return (CR), line feed (LF), or CRLF sequence is used.

Parameters:

recordTerminator - the record termination character

getComments

public String[] getComments()

Returns the array of comment prefixes. If a line read from a stream begins with a configured comment prefix, the line is ignored. By default, no lines are considered commented.

Returns:

the array of comment prefixes

setComments

public void setComments(String[] comments)

Sets the array of comment prefixes. If a line read from a stream begins with a configured comment prefix, the line is ignored.

Parameters:

comments - the array of comment prefixes

isCommentEnabled

public boolean isCommentEnabled()

Returns whether one or more comment prefixes have been configured.

Returns:

true if one or more comment prefixes have been configured