Package de.espirit.common.util

Class CsvReader

java.lang.Object

de.espirit.common.util.CsvReader

public class CsvReader
extends Object

Utility class to parse CSV files.

Usage:

 
 final CsvReader csvReader = new CsvReader(reader, ';');
 CsvReader.CsvToken token = csvReader.read();
 while (token.getType() != CsvReader.CsvToken.EOF) {
     if (token.getType() == CsvReader.CsvToken.NEW_LINE) {
         // handle newline
     } else {
         // handle value
         final String value = token.getValue();
     }
     token = csvReader.read();
 }
  

Since:

5.1.28

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CsvReader.CsvToken	Class representing a single token

Constructor Summary

Constructors

Constructor	Description
CsvReader(@NotNull Reader reader)	Constructs a new CsvReader with the given reader as source of the csv file with default delimiter ';'.
CsvReader(@NotNull Reader reader, char delim)	Constructs a new CsvReader with the given reader as source of the csv file and the given char as delimiter of the csv file

Method Summary

Modifier and Type	Method	Description
static @NotNull List<List<String>>	parseCsvToList(@NotNull Reader reader, char delim)	parses the csv source of the given reader to a list of lists of String's
static @NotNull String[][]	parseCsvToStringArray(@NotNull Reader reader, char delim)	parses the csv source of the given reader to a StringArray of StringArrays
@NotNull CsvReader.CsvToken	read()	Returns a CsvToken of the type CsvReader.CsvToken.VALUE or CsvReader.CsvToken.NEW_LINE or CsvReader.CsvToken.EOF

Methods inherited from class java.lang.Object

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

Constructor Details

CsvReader

public CsvReader(@NotNull
 @NotNull Reader reader,
 char delim)

Constructs a new CsvReader with the given reader as source of the csv file and the given char as delimiter of the csv file

Parameters:

reader - reader for the csv file

delim - the delimiter char of the csv file

Since:

5.1.28

CsvReader

public CsvReader(@NotNull
 @NotNull Reader reader)

Constructs a new CsvReader with the given reader as source of the csv file with default delimiter ';'.

Parameters:

reader - reader for the csv file

Since:

5.1.28

Method Details

read

@NotNull
public @NotNull CsvReader.CsvToken read()
                                 throws IOException

Returns a CsvToken of the type CsvReader.CsvToken.VALUE or CsvReader.CsvToken.NEW_LINE or CsvReader.CsvToken.EOF

Returns:

CsvToken - currentToken

Throws:

IOException - from underlying stream

Since:

5.1.28

See Also:

• CsvReader.CsvToken

parseCsvToList

@NotNull
public static @NotNull List<List<String>> parseCsvToList(@NotNull
 @NotNull Reader reader,
 char delim)
                                                  throws IllegalStateException

parses the csv source of the given reader to a list of lists of String's

Parameters:

reader - the reader for the csv file

delim - the delimiter char of the csv file

Returns:

List - a List of Lists

Throws:

IllegalStateException - if the csv file is invalid, or if a IOException is encountered while reading

Since:

5.1.28

parseCsvToStringArray

@NotNull
public static @NotNull String[][] parseCsvToStringArray(@NotNull
 @NotNull Reader reader,
 char delim)
                                                 throws IllegalStateException

parses the csv source of the given reader to a StringArray of StringArrays

Parameters:

reader - the reader for the csv file

delim - the delimiter char of the csv file

Returns:

String[][] - a StringArray of StringArrays

Throws:

IllegalStateException - if the csv file is invalid, or if a IOException is encountered while reading

Since:

5.1.28