org.ttzero.excel.util

类 CSVUtil

java.lang.Object

org.ttzero.excel.util.CSVUtil

public class CSVUtil
extends Object

Comma-Separated Values

RFC 4180 standard Reliance on the standard documented by RFC 4180 can simplify CSV exchange. However, this standard only specifies handling of text-based fields. Interpretation of the text of each field is still application-specific.

RFC 4180 formalized CSV. It defines the MIME type "text/csv", and CSV files that follow its rules should be very widely portable. Among its requirements:

1. MS-DOS-style lines that end with (CR/LF) characters (optional for the last line). 2. An optional header record (there is no sure way to detect whether it is present, so care is required when importing). 3. Each record "should" contain the same number of comma-separated fields. 4. Any field may be quoted (with double quotes). 5. Fields containing a line-break, double-quote or commas should be quoted. (If they are not, the file will likely be impossible to process correctly). 6. A (double) quote character in a field must be represented by two (double) quote characters.

Create by guanquan.wang at 2019-02-12 17:27

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CSVUtil.Reader A CSV format file reader.
static class	CSVUtil.RowsIterator Rows iterator
static class	CSVUtil.SharedRowsIterator Shared Row iterator
static class	CSVUtil.Writer A CSV format file writer.

方法概要

限定符和类型	方法和说明
static CSVUtil.Reader	newReader(Path path) Create a CSV reader.
static CSVUtil.Reader	newReader(Path path, char separator) Create a CSV reader.
static CSVUtil.Reader	newReader(Path path, char separator, Charset charset) Create a CSV reader.
static CSVUtil.Reader	newReader(Path path, Charset charset) Create a CSV reader.
static CSVUtil.Writer	newWriter(BufferedWriter writer) Create a CSV writer
static CSVUtil.Writer	newWriter(OutputStream os) Create a CSV writer
static CSVUtil.Writer	newWriter(Path path) Create a CSV writer
static CSVUtil.Writer	newWriter(Path path, char separator) Create a CSV writer
static CSVUtil.Writer	newWriter(Path path, char separator, Charset charset) Create a CSV writer
static CSVUtil.Writer	newWriter(Path path, Charset charset) Create a CSV writer
static List<String[]>	read(Path path) Read csv format file by UTF-8 charset.
static List<String[]>	read(Path path, char separator) Read csv format file by UTF-8 charset.
static List<String[]>	read(Path path, char separator, Charset charset) Read csv format file.
static List<String[]>	read(Path path, Charset charset) Read csv format file.
static <T> List<T>	read(Path path, Class<T> clazz) Read csv format file by UTF-8 charset.
static <T> List<T>	read(Path path, Class<T> clazz, Charset charset) Read csv format file.
static void	writeTo(List<?> data, Path path) Save vector object as csv format file

从类继承的方法 java.lang.Object

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

方法详细资料

read

public static <T> List<T> read(Path path,
                               Class<T> clazz)
                        throws IOException

Read csv format file by UTF-8 charset.

类型参数:

T - the result type

参数:

path - the csv file path

clazz - the class convert to

返回:

ArrayList of clazz

抛出:

IOException - if I/O error occur

从以下版本开始:

1.7

read

public static List<String[]> read(Path path)
                           throws IOException

Read csv format file by UTF-8 charset.

参数:

path - the csv file path

返回:

ArrayList of string

抛出:

IOException - if I/O error occur

从以下版本开始:

1.7

read

public static List<String[]> read(Path path,
                                  char separator)
                           throws IOException

Read csv format file by UTF-8 charset.

参数:

path - the csv file path

separator - the separator character

返回:

ArrayList of string

抛出:

IOException - if I/O error occur

从以下版本开始:

1.7

read

public static <T> List<T> read(Path path,
                               Class<T> clazz,
                               Charset charset)
                        throws IOException

Read csv format file.

类型参数:

T - the result type

参数:

path - the csv file path

clazz - the class convert to

charset - the charset to use for encoding

返回:

ArrayList of clazz

抛出:

IOException - if I/O error occur

从以下版本开始:

1.7

read

public static List<String[]> read(Path path,
                                  Charset charset)
                           throws IOException

Read csv format file.

参数:

path - the csv file path

charset - the charset to use for encoding

返回:

ArrayList of string

抛出:

IOException - if I/O error occur

从以下版本开始:

1.7

read

public static List<String[]> read(Path path,
                                  char separator,
                                  Charset charset)
                           throws IOException

Read csv format file.

参数:

path - the csv file path

separator - the separator character

charset - the charset to use for encoding

返回:

ArrayList of string

抛出:

IOException - if I/O error occur

从以下版本开始:

1.7

newReader

public static CSVUtil.Reader newReader(Path path)

Create a CSV reader.

参数:

path - the csv file path

返回:

a stream CSV format reader

newReader

public static CSVUtil.Reader newReader(Path path,
                                       Charset charset)

Create a CSV reader.

参数:

path - the csv file path

charset - the charset to use for encoding

返回:

a stream CSV format reader

newReader

public static CSVUtil.Reader newReader(Path path,
                                       char separator)

Create a CSV reader.

参数:

path - the csv file path

separator - the separator character

返回:

a stream CSV format reader

newReader

public static CSVUtil.Reader newReader(Path path,
                                       char separator,
                                       Charset charset)

Create a CSV reader.

参数:

path - the csv file path

separator - the separator character

charset - the charset to use for encoding

返回:

a stream CSV format reader

writeTo

public static void writeTo(List<?> data,
                           Path path)
                    throws IOException

Save vector object as csv format file

参数:

data - the vector object to be save

path - the save path

抛出:

IOException - if I/O error occur

newWriter

public static CSVUtil.Writer newWriter(Path path)
                                throws IOException

Create a CSV writer

参数:

path - the storage path

返回:

a CSV format writer

抛出:

IOException - no permission or other I/O error occur

newWriter

public static CSVUtil.Writer newWriter(Path path,
                                       Charset charset)
                                throws IOException

Create a CSV writer

参数:

path - the storage path

charset - the charset to use for encoding

返回:

a CSV format writer

抛出:

IOException - no permission or other I/O error occur

newWriter

public static CSVUtil.Writer newWriter(Path path,
                                       char separator)
                                throws IOException

Create a CSV writer

参数:

path - the storage path

separator - the separator character

返回:

a CSV format writer

抛出:

IOException - no permission or other I/O error occur

newWriter

public static CSVUtil.Writer newWriter(Path path,
                                       char separator,
                                       Charset charset)
                                throws IOException

Create a CSV writer

参数:

path - the storage path

separator - the separator character

charset - the charset to use for encoding

返回:

a CSV format writer

抛出:

IOException - no permission or other I/O error occur

newWriter

public static CSVUtil.Writer newWriter(BufferedWriter writer)

Create a CSV writer

参数:

writer - the BufferedWriter

返回:

a CSV format writer

newWriter

public static CSVUtil.Writer newWriter(OutputStream os)

Create a CSV writer

参数:

os - the OutputStream

返回:

a CSV format writer