Package org.supercsv.io
Class AbstractTokenizer
java.lang.Object
org.supercsv.io.AbstractTokenizer
- All Implemented Interfaces:
Closeable
,AutoCloseable
,ITokenizer
- Direct Known Subclasses:
Tokenizer
Defines the standard behaviour of a Tokenizer. Extend this class if you want the line-reading functionality of the
default
Tokenizer
, but want to define your own implementation of ITokenizer.readColumns(List)
.- Since:
- 2.0.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionAbstractTokenizer
(Reader reader, CsvPreference preferences) Constructs a new AbstractTokenizer, which reads the CSV file, line by line. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the underlying reader.int
Gets the line number currently being tokenized (the first line is line 1).protected CsvPreference
Gets the CSV preferences.protected String
readLine()
Reads a line of text.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.supercsv.io.ITokenizer
getUntokenizedRow, readColumns
-
Field Details
-
preferences
-
lnr
-
-
Constructor Details
-
AbstractTokenizer
Constructs a new AbstractTokenizer, which reads the CSV file, line by line.- Parameters:
reader
- the readerpreferences
- the CSV preferences- Throws:
NullPointerException
- if reader or preferences is null
-
-
Method Details
-
close
Closes the underlying reader.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
getLineNumber
public int getLineNumber()Gets the line number currently being tokenized (the first line is line 1). This number increments at every line terminator as the data is read, i.e. it will be- 0, if
ITokenizer.readColumns(List)
hasn't been called yet - 1, when the first line is being read/tokenized
- 2, when the second line is being read/tokenized
- Specified by:
getLineNumber
in interfaceITokenizer
- Returns:
- the line number currently being tokenized
- 0, if
-
readLine
Reads a line of text. Whenever a line terminator is read the current line number is incremented.- Returns:
- A String containing the contents of the line, not including any line termination characters, or null if the end of the stream has been reached
- Throws:
IOException
- If an I/O error occurs
-
getPreferences
Gets the CSV preferences.- Returns:
- the preferences
-