org.spf4j.io

Class Csv

java.lang.Object

org.spf4j.io.Csv

@ParametersAreNonnullByDefault
public final class Csv
extends Object

Supports CSV format as described at: https://en.wikipedia.org/wiki/Comma-separated_values. either of \n \r or \r\n 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Csv.CsvHandler<T>
static interface	Csv.CsvMapHandler<T>
static interface	Csv.CsvRowHandler<T>

Field Summary

Fields

Modifier and Type	Field and Description
static CharSeparatedValues	CSV

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

CSV

public static final CharSeparatedValues CSV

Method Detail

writeCsvRow

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

Throws:

IOException

writeCsvRow2

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

Throws:

IOException

writeCsvRow

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

Throws:

IOException

writeCsvRowNoEOL

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

Throws:

IOException

writeCsvRow

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

Throws:

IOException

writeCsvRowNoEOL

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

Throws:

IOException

read

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

Throws:

IOException

CsvParseException

read

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

Throws:

IOException

CsvParseException

read

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

Throws:

IOException

CsvParseException

read

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

Throws:

IOException

CsvParseException

readRow

public static List<String> readRow(String row)
                            throws CsvParseException

Throws:

CsvParseException

readRow

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

Throws:

IOException

CsvParseException

readRow

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

Throws:

IOException

CsvParseException

read

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

Throws:

IOException

CsvParseException

readNoBom

public static <T> T readNoBom(PushbackReader reader,
                              Csv.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 static 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 static CsvReader reader(Reader preader)
                        throws IOException

Throws:

IOException

readerNoBOM

public static CsvReader readerNoBOM(PushbackReader reader)

writeCsvElement

public static 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 static CharSequence toCsvElement(CharSequence elem)

readCsvElement

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

returns next character.

Parameters:

reader -

addElemTo -

Returns:

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

Throws:

IOException