org.spf4j.io.csv

Class CharSeparatedValues

java.lang.Object

org.spf4j.io.csv.CharSeparatedValues

@ParametersAreNonnullByDefault
public final class CharSeparatedValues
extends Object

Supports Character Separated values format as described at: https://en.wikipedia.org/wiki/Comma-separated_values. either of \n \r or \r\n generalized to custom separator character. are valid end of line delimiters why another implementation? because I need one that is as fast as possible, and as flexible as possible.

Author:

zoly

Field Summary

Fields

Modifier and Type	Field and Description
static int	UTF_BOM http://unicode.org/faq/utf_bom.html#BOM

Constructor Summary

Constructors

Constructor and Description
CharSeparatedValues(char separator)
CharSeparatedValues(char separator, char... extraCharsToEscape)

Method Summary

Modifier and Type	Method and Description
Iterable<Iterable<String>>	asIterable(Reader preader) read a CSV stream, as a Iterable over rows.
<T> T	read(File file, Charset charset, CsvHandler<T> handler)
<T> T	read(File file, Charset charset, CsvMapHandler<T> handler)
List<Map<String,String>>	read(Reader preader)
<T> T	read(Reader preader, CsvHandler<T> handler)
<T> T	read(Reader preader, CsvMapHandler<T> handler)
int	readCsvElement(Reader reader, StringBuilder addElemTo, int lineNr) returns next character.
CsvReader	reader(Reader preader)
CsvReader	readerNoBOM(PushbackReader reader)
<T> T	readNoBom(PushbackReader reader, CsvHandler<T> handler) reads CSV format until EOF of reader.
List<String>	readRow(Reader reader)
<T> T	readRow(Reader reader, CsvRowHandler<T> handler)
CharSequence	toCsvElement(CharSequence elem)
String	toString()
void	writeCsvElement(CharSequence elem, Appendable writer)
void	writeCsvRow(Appendable writer, Iterable<?> elems)
void	writeCsvRow(Appendable writer, long... elems)
void	writeCsvRow(Appendable writer, Object... elems)
void	writeCsvRow2(Appendable writer, Object obj, Object... elems)
void	writeCsvRowNoEOL(Appendable writer, Object... elems)
void	writeCsvRowNoEOL(Iterable<?> elems, Appendable writer)
void	writeCsvRowNoEOL(long[] elems, Appendable writer)
static void	writeQuotedCsvElement(CharSequence elem, Appendable writer)
CsvWriter	writer(Writer writer)

Methods inherited from class java.lang.Object

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

Field Detail

UTF_BOM

public static final int UTF_BOM

http://unicode.org/faq/utf_bom.html#BOM

See Also:

Constant Field Values

Constructor Detail

CharSeparatedValues

public CharSeparatedValues(char separator)

CharSeparatedValues

public CharSeparatedValues(char separator,
                           char... extraCharsToEscape)

Method Detail

writeCsvRow

public void writeCsvRow(Appendable writer,
                        Object... elems)
                 throws IOException

Throws:

IOException

writeCsvRowNoEOL

public void writeCsvRowNoEOL(Appendable writer,
                             Object... elems)
                      throws IOException

Throws:

IOException

writeCsvRow2

public void writeCsvRow2(Appendable writer,
                         Object obj,
                         Object... elems)
                  throws IOException

Throws:

IOException

writeCsvRow

public void writeCsvRow(Appendable writer,
                        long... elems)
                 throws IOException

Throws:

IOException

writeCsvRowNoEOL

public void writeCsvRowNoEOL(long[] elems,
                             Appendable writer)
                      throws IOException

Throws:

IOException

writeCsvRow

public void writeCsvRow(Appendable writer,
                        Iterable<?> elems)
                 throws IOException

Throws:

IOException

writeCsvRowNoEOL

public void writeCsvRowNoEOL(Iterable<?> elems,
                             Appendable writer)
                      throws IOException

Throws:

IOException

read

public <T> T read(File file,
                  Charset charset,
                  CsvMapHandler<T> handler)
           throws IOException,
                  CsvParseException

Throws:

IOException

CsvParseException

read

public <T> T read(File file,
                  Charset charset,
                  CsvHandler<T> handler)
           throws IOException,
                  CsvParseException

Throws:

IOException

CsvParseException

read

public List<Map<String,String>> read(Reader preader)
                              throws IOException,
                                     CsvParseException

Throws:

IOException

CsvParseException

read

public <T> T read(Reader preader,
                  CsvMapHandler<T> handler)
           throws IOException,
                  CsvParseException

Throws:

IOException

CsvParseException

readRow

public List<String> readRow(Reader reader)
                     throws IOException,
                            CsvParseException

Throws:

IOException

CsvParseException

readRow

public <T> T readRow(Reader reader,
                     CsvRowHandler<T> handler)
              throws IOException,
                     CsvParseException

Throws:

IOException

CsvParseException

read

public <T> T read(Reader preader,
                  CsvHandler<T> handler)
           throws IOException,
                  CsvParseException

Throws:

IOException

CsvParseException

readNoBom

public <T> T readNoBom(PushbackReader reader,
                       CsvHandler<T> handler)
                throws IOException,
                       CsvParseException

reads CSV format until EOF of reader.

Type Parameters:

T -

Parameters:

preader -

handler -

Returns:

Throws:

IOException

CsvParseException

asIterable

public Iterable<Iterable<String>> asIterable(Reader preader)

read a CSV stream, as a Iterable over rows. the List instance is reused during iteration, you will need to copy content into own data structure.

Parameters:

preader -

Returns:

reader

public CsvReader reader(Reader preader)
                 throws IOException

Throws:

IOException

readerNoBOM

public CsvReader readerNoBOM(PushbackReader reader)

writer

public CsvWriter writer(Writer writer)

writeCsvElement

public void writeCsvElement(CharSequence elem,
                            Appendable writer)
                     throws IOException

Throws:

IOException

writeQuotedCsvElement

public static void writeQuotedCsvElement(CharSequence elem,
                                         Appendable writer)
                                  throws IOException

Throws:

IOException

toCsvElement

public CharSequence toCsvElement(CharSequence elem)

readCsvElement

@CheckReturnValue
public int readCsvElement(Reader reader,
                                            StringBuilder addElemTo,
                                            int lineNr)
                                     throws IOException,
                                            CsvParseException

returns next character.

Parameters:

reader -

addElemTo -

Returns:

- next character or -1 if eof has been reached.

Throws:

IOException

CsvParseException

toString

public String toString()

Overrides:

toString in class Object