com.asakusafw.runtime.io.text.csv

Class CsvTextFormat

java.lang.Object

com.asakusafw.runtime.io.text.csv.CsvTextFormat

All Implemented Interfaces:

TextFormat

public class CsvTextFormat
extends Object
implements TextFormat

An implementation of TextFormat for RFC4180 style CSV files.

Since:

0.9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CsvTextFormat.Builder A builder of CsvTextFormat.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ALLOW_LINE_FEED_IN_FIELD The default value of whether or not line-feed characters can appear in field.
static Charset	DEFAULT_CHARSET The default charset.
static char	DEFAULT_FIELD_SEPARATOR The default field separator.
static LineSeparator	DEFAULT_LINE_SEPARATOR The default line separator.
static char	DEFAULT_QUOTE_CHARACTER The default quote character.
static QuoteStyle	DEFAULT_QUOTE_STYLE The default quote style.

Method Summary

Modifier and Type	Method and Description
static CsvTextFormat.Builder	builder() Returns a new builder.
CsvFieldReader	open(InputStream input) Opens FieldReader for the given input.
CsvFieldWriter	open(OutputStream output) Opens FieldWriter for the given output.
CsvFieldReader	open(Reader input) Opens FieldReader for the given input.
CsvFieldWriter	open(Writer output) Opens FieldWriter for the given output.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

The default charset.

DEFAULT_LINE_SEPARATOR

public static final LineSeparator DEFAULT_LINE_SEPARATOR

The default line separator.

DEFAULT_FIELD_SEPARATOR

public static final char DEFAULT_FIELD_SEPARATOR

The default field separator.

See Also:

Constant Field Values

DEFAULT_QUOTE_CHARACTER

public static final char DEFAULT_QUOTE_CHARACTER

The default quote character.

See Also:

Constant Field Values

DEFAULT_ALLOW_LINE_FEED_IN_FIELD

public static final boolean DEFAULT_ALLOW_LINE_FEED_IN_FIELD

The default value of whether or not line-feed characters can appear in field.

See Also:

Constant Field Values

DEFAULT_QUOTE_STYLE

public static final QuoteStyle DEFAULT_QUOTE_STYLE

The default quote style.

Method Detail

builder

public static final CsvTextFormat.Builder builder()

Returns a new builder.

Returns:

the created builder

open

public CsvFieldReader open(InputStream input)
                    throws IOException

Description copied from interface: TextFormat

Opens FieldReader for the given input.

Specified by:

open in interface TextFormat

Parameters:

input - the source input stream

Returns:

the opened FieldReader

Throws:

IOException - if I/O error was occurred while initializing the reader

open

public CsvFieldWriter open(OutputStream output)
                    throws IOException

Description copied from interface: TextFormat

Opens FieldWriter for the given output.

Specified by:

open in interface TextFormat

Parameters:

output - the destination output stream

Returns:

the opened FieldWriter

Throws:

IOException - if I/O error was occurred while initializing the writer

open

public CsvFieldReader open(Reader input)
                    throws IOException

Description copied from interface: TextFormat

Opens FieldReader for the given input.

Specified by:

open in interface TextFormat

Parameters:

input - the source input reader

Returns:

the opened FieldReader

Throws:

IOException - if I/O error was occurred while initializing the reader

open

public CsvFieldWriter open(Writer output)
                    throws IOException

Description copied from interface: TextFormat

Opens FieldWriter for the given output.

Specified by:

open in interface TextFormat

Parameters:

output - the destination output writer

Returns:

the opened FieldWriter

Throws:

IOException - if I/O error was occurred while initializing the writer