Interface CharInputReader
-
- All Superinterfaces:
CharInput
- All Known Implementing Classes:
AbstractCharInputReader
,ConcurrentCharInputReader
,DefaultCharInputReader
,LookaheadCharInputReader
public interface CharInputReader extends CharInput
The definition of a character input reader used by all uniVocity-parsers that extendAbstractParser
.This interface declares basic functionalities to provide a common input manipulation structure for all parser classes.
Implementations of this interface MUST convert the sequence of newline characters defined by
Format.getLineSeparator()
into the normalized newline character provided inFormat.getNormalizedNewline()
.- Author:
- uniVocity Software Pty Ltd - parsers@univocity.com
- See Also:
Format
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
charCount()
Returns the number of characters returned bynextChar()
at any given time.java.lang.String
currentParsedContent()
Returns a String with the input character sequence parsed to produce the current record.void
enableNormalizeLineEndings(boolean escaping)
Indicates to the input reader that the parser is running in "escape" mode and new lines should be returned as-is to prevent modifying the content of the parsed value.char
getChar()
Returns the last character returned by thenextChar()
method.char[]
getLineSeparator()
Returns the line separator by this character input reader.java.lang.String
getString(char ch, char stop, boolean trim, java.lang.String nullValue, int maxLength)
Attempts to collect aString
from the current position until a stop character is found on the input, or a line ending is reached.long
lineCount()
Returns the number of newlines read so far.void
markRecordStart()
Marks the start of a new record in the input, used internally to calculate the result ofcurrentParsedContent()
char
nextChar()
Returns the next character in the input provided by the activeReader
.java.lang.String
readComment()
Collects the comment line found on the input.void
skipLines(long lineCount)
Skips characters in the input until the given number of lines is discarded.char
skipWhitespace(char current, char stopChar1, char stopChar2)
Skips characters from the current input position, until a non-whitespace character, or a stop character is foundvoid
start(java.io.Reader reader)
Initializes the CharInputReader implementation with aReader
which provides access to the input.void
stop()
Stops the CharInputReader from reading characters from theReader
provided instart(Reader)
and closes it.
-
-
-
Method Detail
-
start
void start(java.io.Reader reader)
Initializes the CharInputReader implementation with aReader
which provides access to the input.- Parameters:
reader
- AReader
that provides access to the input.
-
stop
void stop()
Stops the CharInputReader from reading characters from theReader
provided instart(Reader)
and closes it.
-
nextChar
char nextChar()
Returns the next character in the input provided by the activeReader
.If the input contains a sequence of newline characters (defined by
Format.getLineSeparator()
), this method will automatically converted them to the newline character specified inFormat.getNormalizedNewline()
.A subsequent call to this method will return the character after the newline sequence.
-
getChar
char getChar()
Returns the last character returned by thenextChar()
method.- Specified by:
getChar
in interfaceCharInput
- Returns:
- the last character returned by the
nextChar()
method.'\0' if there are no more characters in the input or if the CharInputReader was stopped.
-
charCount
long charCount()
Returns the number of characters returned bynextChar()
at any given time.- Returns:
- the number of characters returned by
nextChar()
-
lineCount
long lineCount()
Returns the number of newlines read so far.- Returns:
- the number of newlines read so far.
-
skipLines
void skipLines(long lineCount)
Skips characters in the input until the given number of lines is discarded.- Parameters:
lineCount
- the number of lines to skip from the current location in the input
-
readComment
java.lang.String readComment()
Collects the comment line found on the input.- Returns:
- the text found in the comment from the current position.
-
enableNormalizeLineEndings
void enableNormalizeLineEndings(boolean escaping)
Indicates to the input reader that the parser is running in "escape" mode and new lines should be returned as-is to prevent modifying the content of the parsed value.- Parameters:
escaping
- flag indicating that the parser is escaping values and line separators are to be returned as-is.
-
getLineSeparator
char[] getLineSeparator()
Returns the line separator by this character input reader. This could be the line separator defined in theFormat.getLineSeparator()
configuration, or the line separator sequence identified automatically whenCommonParserSettings.isLineSeparatorDetectionEnabled()
evaluates totrue
.- Returns:
- the line separator in use.
-
skipWhitespace
char skipWhitespace(char current, char stopChar1, char stopChar2)
Skips characters from the current input position, until a non-whitespace character, or a stop character is found- Parameters:
current
- the current character of the inputstopChar1
- the first stop character (which can be a whitespace)stopChar2
- the second character (which can be a whitespace)- Returns:
- the first non-whitespace character (or delimiter) found in the input.
-
currentParsedContent
java.lang.String currentParsedContent()
Returns a String with the input character sequence parsed to produce the current record.- Returns:
- the text content parsed for the current input record.
-
markRecordStart
void markRecordStart()
Marks the start of a new record in the input, used internally to calculate the result ofcurrentParsedContent()
-
getString
java.lang.String getString(char ch, char stop, boolean trim, java.lang.String nullValue, int maxLength)
Attempts to collect aString
from the current position until a stop character is found on the input, or a line ending is reached. If theString
can be obtained, the current position of the parser will be updated to the last consumed character. If the internal buffer needs to be reloaded, this method will returnnull
and the current position of the buffer will remain unchanged.- Parameters:
ch
- the current character to be considered. If equal to the stop character thenullValue
will be returnedstop
- the stop character that identifies the end of the content to be collectedtrim
- flag indicating whether or not trailing whitespaces should be discardednullValue
- value to return when the length of the content to be returned is0
.maxLength
- the maximum length of theString
to be returned. If the length exceeds this limit,null
will be returned- Returns:
- the
String
found on the input, ornull
if the buffer needs to reloaded or the maximum length has been exceeded.
-
-