CsvConfiguration (Asakusa Framework 0.10.4 API)

java.lang.Object
- com.asakusafw.runtime.io.csv.CsvConfiguration

public class CsvConfiguration
extends Object

CSV configurations.

Since:: 0.2.4
Version:: 0.9.0

Field Summary

Fields
Modifier and Type	Field and Description
`static Charset`	`DEFAULT_CHARSET` The default charset encoding.
`static String`	`DEFAULT_DATE_FORMAT` The default date format.
`static String`	`DEFAULT_DATE_TIME_FORMAT` The default date time format.
`static String`	`DEFAULT_FALSE_FORMAT` The default `false` representation.
`static boolean`	`DEFAULT_FORCE_CONSUME_HEADER` The default configuration whether forcibly consumes header cells even if header contents is invalid or not.
`static List<String>`	`DEFAULT_HEADER_CELLS` The default header cells (empty list).
`static boolean`	`DEFAULT_LINE_BREAK_IN_VALUE` The default configuration whether allows line breaks in value.
`static char`	`DEFAULT_SEPARATOR_CHAR` The default field separator character.
`static String`	`DEFAULT_TRUE_FORMAT` The default `true` representation.

Constructor Summary

Constructors
Constructor and Description
`CsvConfiguration(Charset charset, List<String> headerCells, String trueFormat, String falseFormat, String dateFormat, String dateTimeFormat)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Charset`	`getCharset()` Returns the character set encoding name.
`String`	`getDateFormat()` The `Date` format in `SimpleDateFormat`.
`String`	`getDateTimeFormat()` The `DateTime` format in `SimpleDateFormat`.
`String`	`getFalseFormat()` The boolean `false` format.
`int[]`	`getForceQuoteColumns()` Returns column indices which quoting is always required.
`List<String>`	`getHeaderCells()` The header cell values.
`char`	`getSeparatorChar()` Returns the field separator character.
`String`	`getTrueFormat()` The boolean `true` format.
`boolean`	`isForceConsumeHeader()` Returns whether forcibly consumes header cells or not.
`boolean`	`isLineBreakInValue()` Returns whether allows line breaks in value.
`void`	`setForceConsumeHeader(boolean newValue)` Sets whether forcibly consumes header cells or not.
`void`	`setForceQuoteColumns(int... indices)` Sets column indices which quoting is always required.
`void`	`setLineBreakInValue(boolean allow)` Sets whether allows line breaks in value.
`void`	`setSeparatorChar(char separatorChar)` Sets the field separator character.

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 encoding.
    
    See Also:
    
    getCharset()
  - DEFAULT_HEADER_CELLS
```
public static final List<String> DEFAULT_HEADER_CELLS
```
    The default header cells (empty list).
    
    See Also:
    
    getHeaderCells()
  - DEFAULT_TRUE_FORMAT
```
public static final String DEFAULT_TRUE_FORMAT
```
    The default true representation.
    
    See Also:
    
    getTrueFormat(), Constant Field Values
  - DEFAULT_FALSE_FORMAT
```
public static final String DEFAULT_FALSE_FORMAT
```
    The default false representation.
    
    See Also:
    
    getFalseFormat(), Constant Field Values
  - DEFAULT_DATE_FORMAT
```
public static final String DEFAULT_DATE_FORMAT
```
    The default date format.
    
    See Also:
    
    getDateFormat(), Constant Field Values
  - DEFAULT_DATE_TIME_FORMAT
```
public static final String DEFAULT_DATE_TIME_FORMAT
```
    The default date time format.
    
    See Also:
    
    getDateTimeFormat(), Constant Field Values
  - DEFAULT_SEPARATOR_CHAR
```
public static final char DEFAULT_SEPARATOR_CHAR
```
    The default field separator character.
    
    See Also:
    
    getSeparatorChar(), Constant Field Values
  - DEFAULT_LINE_BREAK_IN_VALUE
```
public static final boolean DEFAULT_LINE_BREAK_IN_VALUE
```
    The default configuration whether allows line breaks in value.
    
    See Also:
    
    isLineBreakInValue(), Constant Field Values
  - DEFAULT_FORCE_CONSUME_HEADER
```
public static final boolean DEFAULT_FORCE_CONSUME_HEADER
```
    The default configuration whether forcibly consumes header cells even if header contents is invalid or not.
    
    See Also:
    
    isForceConsumeHeader(), Constant Field Values
- Constructor Detail
  - CsvConfiguration
```
public CsvConfiguration(Charset charset,
                        List<String> headerCells,
                        String trueFormat,
                        String falseFormat,
                        String dateFormat,
                        String dateTimeFormat)
```
    Creates a new instance.
    
    Parameters:
    
    charset - character set encoding name
    
    headerCells - header cell values, or an empty list for no header
    
    trueFormat - the true representation
    
    falseFormat - the false representation
    
    dateFormat - Date format in SimpleDateFormat
    
    dateTimeFormat - DateTime format in SimpleDateFormat
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
- Method Detail
  - getCharset
```
public Charset getCharset()
```
    Returns the character set encoding name.
    
    Returns:
    
    the encoding
  - getHeaderCells
```
public List<String> getHeaderCells()
```
    The header cell values.
    
    Returns:
    
    the cell values, or an empty list to represent no headers
  - getTrueFormat
```
public String getTrueFormat()
```
    The boolean true format.
    
    Returns:
    
    the format string
  - getFalseFormat
```
public String getFalseFormat()
```
    The boolean false format.
    
    Returns:
    
    the format string
  - getDateFormat
```
public String getDateFormat()
```
    The Date format in SimpleDateFormat.
    
    Returns:
    
    the format string
  - getDateTimeFormat
```
public String getDateTimeFormat()
```
    The DateTime format in SimpleDateFormat.
    
    Returns:
    
    the format string
  - isLineBreakInValue
```
public boolean isLineBreakInValue()
```
    Returns whether allows line breaks in value.
    
    Returns:
    
    true if allow, otherwise false
  - setLineBreakInValue
```
public void setLineBreakInValue(boolean allow)
```
    Sets whether allows line breaks in value.
    
    Parameters:
    
    allow - true to allow, otherwise false
  - getSeparatorChar
```
public char getSeparatorChar()
```
    Returns the field separator character.
    
    Returns:
    
    the separator
  - setSeparatorChar
```
public void setSeparatorChar(char separatorChar)
```
    Sets the field separator character.
    
    Parameters:
    
    separatorChar - the separator
  - isForceConsumeHeader
```
public boolean isForceConsumeHeader()
```
    Returns whether forcibly consumes header cells or not.
    
    Returns:
    
    true to forcibly consumes the header cell, otherwise false
    
    Since:
    
    0.7.3
  - setForceConsumeHeader
```
public void setForceConsumeHeader(boolean newValue)
```
    Sets whether forcibly consumes header cells or not.
    
    Parameters:
    
    newValue - true to forcibly consumes the header cell, otherwise false
    
    Since:
    
    0.7.3
  - getForceQuoteColumns
```
public int[] getForceQuoteColumns()
```
    Returns column indices which quoting is always required.
    
    Returns:
    
    the column indices
    
    Since:
    
    0.9.0
  - setForceQuoteColumns
```
public void setForceQuoteColumns(int... indices)
```
    Sets column indices which quoting is always required.
    
    Parameters:
    
    indices - the column indices
    
    Since:
    
    0.9.0

Class CsvConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CHARSET

DEFAULT_HEADER_CELLS

DEFAULT_TRUE_FORMAT

DEFAULT_FALSE_FORMAT

DEFAULT_DATE_FORMAT

DEFAULT_DATE_TIME_FORMAT

DEFAULT_SEPARATOR_CHAR

DEFAULT_LINE_BREAK_IN_VALUE

DEFAULT_FORCE_CONSUME_HEADER

Constructor Detail

CsvConfiguration

Method Detail

getCharset

getHeaderCells

getTrueFormat

getFalseFormat

getDateFormat

getDateTimeFormat

isLineBreakInValue

setLineBreakInValue

getSeparatorChar

setSeparatorChar

isForceConsumeHeader

setForceConsumeHeader

getForceQuoteColumns

setForceQuoteColumns