jOOQ 3.18.7 · org.jooq.tools.csv.CSVReader

Modifier and Type	Field and Description
private BufferedReader	br
public static final int	DEFAULT_SKIP_LINES The default line to start reading.
private boolean	hasNext
private boolean	linesSkiped
private CSVParser	parser
private int	skipLines

Constructor Summary

Access	Constructor and Description
public	CSVReader(Reader the reader to an underlying CSV source. reader) Constructs CSVReader using a comma for the separator.
public	CSVReader(Reader the reader to an underlying CSV source. reader, char the delimiter to use for separating entries. separator) Constructs CSVReader with supplied separator.
public	CSVReader(Reader the reader to an underlying CSV source. reader, char the delimiter to use for separating entries separator, char the character to use for quoted elements quotechar) Constructs CSVReader with supplied separator and quote char.
public	CSVReader(Reader the reader to an underlying CSV source. reader, char the delimiter to use for separating entries separator, char the character to use for quoted elements quotechar, boolean sets if characters outside the quotes are ignored strictQuotes) Constructs CSVReader with supplied separator, quote char and quote handling behavior.
public	CSVReader(Reader the reader to an underlying CSV source. reader, char the delimiter to use for separating entries separator, char the character to use for quoted elements quotechar, char the character to use for escaping a separator or quote escape) Constructs CSVReader with supplied separator and quote char.
public	CSVReader(Reader the reader to an underlying CSV source. reader, char the delimiter to use for separating entries separator, char the character to use for quoted elements quotechar, int the line number to skip for start reading line) Constructs CSVReader with supplied separator and quote char.
public	CSVReader(Reader the reader to an underlying CSV source. reader, char the delimiter to use for separating entries separator, char the character to use for quoted elements quotechar, char the character to use for escaping a separator or quote escape, int the line number to skip for start reading line) Constructs CSVReader with supplied separator and quote char.
public	CSVReader(Reader the reader to an underlying CSV source. reader, char the delimiter to use for separating entries separator, char the character to use for quoted elements quotechar, char the character to use for escaping a separator or quote escape, int the line number to skip for start reading line, boolean sets if characters outside the quotes are ignored strictQuotes) Constructs CSVReader with supplied separator and quote char.
public	CSVReader(Reader the reader to an underlying CSV source. reader, char the delimiter to use for separating entries separator, char the character to use for quoted elements quotechar, char the character to use for escaping a separator or quote escape, int the line number to skip for start reading line, boolean sets if characters outside the quotes are ignored strictQuotes, boolean it true, parser should ignore white space before a quote in a field ignoreLeadingWhiteSpace) Constructs CSVReader with supplied separator and quote char.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes the underlying reader.
private String	Returns: the next line from the file without trailing newline getNextLine() Reads the next line from the file.
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public String[]	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public List<String[]>	Returns: a List of String[], with each String[] representing a line of the file. readAll() Reads the entire file into a List with each element being a String[] of tokens.
public String[]	Returns: a string array with each comma-separated element as a separate entry. readNext() Reads the next line from the buffer and converts to a string array.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

br	back to summary
private BufferedReader br

DEFAULT_SKIP_LINES	back to summary
public static final int DEFAULT_SKIP_LINES The default line to start reading.

hasNext	back to summary
private boolean hasNext

linesSkiped	back to summary
private boolean linesSkiped

parser	back to summary
private CSVParser parser

skipLines	back to summary
private int skipLines

Constructor Detail

CSVReader	back to summary
public CSVReader(Reader reader) Constructs CSVReader using a comma for the separator. Parameters reader:Reader the reader to an underlying CSV source.

CSVReader

back to summary

public CSVReader(Reader reader)

Constructs CSVReader using a comma for the separator.

Parameters

reader:Reader: the reader to an underlying CSV source.

CSVReader	back to summary
public CSVReader(Reader reader, char separator) Constructs CSVReader with supplied separator. Parameters reader:Reader the reader to an underlying CSV source. separator:char the delimiter to use for separating entries.

CSVReader

back to summary

public CSVReader(Reader reader, char separator)

Constructs CSVReader with supplied separator.

Parameters

reader:Reader: the reader to an underlying CSV source.
separator:char: the delimiter to use for separating entries.

CSVReader	back to summary
public CSVReader(Reader reader, char separator, char quotechar) Constructs CSVReader with supplied separator and quote char. Parameters reader:Reader the reader to an underlying CSV source. separator:char the delimiter to use for separating entries quotechar:char the character to use for quoted elements

CSVReader

back to summary

public CSVReader(Reader reader, char separator, char quotechar)

Constructs CSVReader with supplied separator and quote char.

Parameters

reader:Reader: the reader to an underlying CSV source.
separator:char: the delimiter to use for separating entries
quotechar:char: the character to use for quoted elements

CSVReader	back to summary
public CSVReader(Reader reader, char separator, char quotechar, boolean strictQuotes) Constructs CSVReader with supplied separator, quote char and quote handling behavior. Parameters reader:Reader the reader to an underlying CSV source. separator:char the delimiter to use for separating entries quotechar:char the character to use for quoted elements strictQuotes:boolean sets if characters outside the quotes are ignored

CSVReader

back to summary

public CSVReader(Reader reader, char separator, char quotechar, boolean strictQuotes)

Constructs CSVReader with supplied separator, quote char and quote handling behavior.

Parameters

reader:Reader: the reader to an underlying CSV source.
separator:char: the delimiter to use for separating entries
quotechar:char: the character to use for quoted elements
strictQuotes:boolean: sets if characters outside the quotes are ignored

CSVReader	back to summary
public CSVReader(Reader reader, char separator, char quotechar, char escape) Constructs CSVReader with supplied separator and quote char. Parameters reader:Reader the reader to an underlying CSV source. separator:char the delimiter to use for separating entries quotechar:char the character to use for quoted elements escape:char the character to use for escaping a separator or quote

CSVReader

back to summary

public CSVReader(Reader reader, char separator, char quotechar, char escape)

Constructs CSVReader with supplied separator and quote char.

Parameters

reader:Reader: the reader to an underlying CSV source.
separator:char: the delimiter to use for separating entries
quotechar:char: the character to use for quoted elements
escape:char: the character to use for escaping a separator or quote

CSVReader	back to summary
public CSVReader(Reader reader, char separator, char quotechar, int line) Constructs CSVReader with supplied separator and quote char. Parameters reader:Reader the reader to an underlying CSV source. separator:char the delimiter to use for separating entries quotechar:char the character to use for quoted elements line:int the line number to skip for start reading

CSVReader

back to summary

public CSVReader(Reader reader, char separator, char quotechar, int line)

Constructs CSVReader with supplied separator and quote char.

Parameters

reader:Reader: the reader to an underlying CSV source.
separator:char: the delimiter to use for separating entries
quotechar:char: the character to use for quoted elements
line:int: the line number to skip for start reading

CSVReader	back to summary
public CSVReader(Reader reader, char separator, char quotechar, char escape, int line) Constructs CSVReader with supplied separator and quote char. Parameters reader:Reader the reader to an underlying CSV source. separator:char the delimiter to use for separating entries quotechar:char the character to use for quoted elements escape:char the character to use for escaping a separator or quote line:int the line number to skip for start reading

CSVReader

back to summary

public CSVReader(Reader reader, char separator, char quotechar, char escape, int line)

Constructs CSVReader with supplied separator and quote char.

Parameters

reader:Reader: the reader to an underlying CSV source.
separator:char: the delimiter to use for separating entries
quotechar:char: the character to use for quoted elements
escape:char: the character to use for escaping a separator or quote
line:int: the line number to skip for start reading

CSVReader	back to summary
public CSVReader(Reader reader, char separator, char quotechar, char escape, int line, boolean strictQuotes) Constructs CSVReader with supplied separator and quote char. Parameters reader:Reader the reader to an underlying CSV source. separator:char the delimiter to use for separating entries quotechar:char the character to use for quoted elements escape:char the character to use for escaping a separator or quote line:int the line number to skip for start reading strictQuotes:boolean sets if characters outside the quotes are ignored

CSVReader

back to summary

public CSVReader(Reader reader, char separator, char quotechar, char escape, int line, boolean strictQuotes)

Constructs CSVReader with supplied separator and quote char.

Parameters

reader:Reader: the reader to an underlying CSV source.
separator:char: the delimiter to use for separating entries
quotechar:char: the character to use for quoted elements
escape:char: the character to use for escaping a separator or quote
line:int: the line number to skip for start reading
strictQuotes:boolean: sets if characters outside the quotes are ignored

CSVReader	back to summary
public CSVReader(Reader reader, char separator, char quotechar, char escape, int line, boolean strictQuotes, boolean ignoreLeadingWhiteSpace) Constructs CSVReader with supplied separator and quote char. Parameters reader:Reader the reader to an underlying CSV source. separator:char the delimiter to use for separating entries quotechar:char the character to use for quoted elements escape:char the character to use for escaping a separator or quote line:int the line number to skip for start reading strictQuotes:boolean sets if characters outside the quotes are ignored ignoreLeadingWhiteSpace:boolean it true, parser should ignore white space before a quote in a field

CSVReader

back to summary

public CSVReader(Reader reader, char separator, char quotechar, char escape, int line, boolean strictQuotes, boolean ignoreLeadingWhiteSpace)

Constructs CSVReader with supplied separator and quote char.

Parameters

reader:Reader: the reader to an underlying CSV source.
separator:char: the delimiter to use for separating entries
quotechar:char: the character to use for quoted elements
escape:char: the character to use for escaping a separator or quote
line:int: the line number to skip for start reading
strictQuotes:boolean: sets if characters outside the quotes are ignored
ignoreLeadingWhiteSpace:boolean: it true, parser should ignore white space before a quote in a field

Method Detail

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Closes the underlying reader. Annotations @Override Exceptions IOException: if the close fails

back to summary

public void close() throws IOException

Implements java.io.Closeable.close.

Closes the underlying reader.

Annotations

@Override

Exceptions

IOException:: if the close fails

getNextLine	back to summary
private String getNextLine() throws IOException Reads the next line from the file. Returns:String the next line from the file without trailing newline Exceptions IOException: if bad things happen during the read

getNextLine

back to summary

private String getNextLine() throws IOException

Reads the next line from the file.

Returns:String

the next line from the file without trailing newline

Exceptions

IOException:: if bad things happen during the read

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public String[] next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:String[] the next element in the iteration Annotations @Override

back to summary

public String[] next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:String[]

the next element in the iteration

Annotations

@Override

readAll	back to summary
public List<String[]> readAll() throws IOException Reads the entire file into a List with each element being a String[] of tokens. Returns:List<String[]> a List of String[], with each String[] representing a line of the file. Exceptions IOException: if bad things happen during the read

readAll

back to summary

public List<String[]> readAll() throws IOException

Reads the entire file into a List with each element being a String[] of tokens.

Returns:List<String[]>

a List of String[], with each String[] representing a line of the file.

Exceptions

IOException:: if bad things happen during the read

readNext	back to summary
public String[] readNext() throws IOException Reads the next line from the buffer and converts to a string array. Returns:String[] a string array with each comma-separated element as a separate entry. Exceptions IOException: if bad things happen during the read

readNext

back to summary

public String[] readNext() throws IOException

Reads the next line from the buffer and converts to a string array.

Returns:String[]

a string array with each comma-separated element as a separate entry.

Exceptions

IOException:: if bad things happen during the read

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public Class CSVReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail