FileMakingOption (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.helper.token.file.FileMakingOption

public class FileMakingOption
extends Object

The option of file-making.

 e.g. TSV, UTF-8, with header
  new FileMakingOption().delimitateByTab().encodeAsUTF8().headerInfo(columnNameList)

作成者:: jflute

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected String`	`_delimiter` The delimiter of data.
`protected String`	`_encoding` The encoding for the file.
`protected FileMakingHeaderInfo`	`_headerInfo` The header info of file-making.
`protected String`	`_lineSeparator` The line separator for the file.
`protected boolean`	`_quoteMinimally` Does it quote values minimally?
`protected boolean`	`_suppressValueCountCheck` Does it suppress value count check?

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

FileMakingOption()

コンストラクタ
コンストラクタと説明
`FileMakingOption()`

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`FileMakingOption`	`delimitateByComma()` Delimitate by Comma.
`FileMakingOption`	`delimitateByTab()` Delimitate by Tab.
`FileMakingOption`	`encodeAsUTF8()` Encode file as UTF-8.
`FileMakingOption`	`encodeAsWindows31J()` Encode file as Windows-31J.
`String`	`getDelimiter()`
`String`	`getEncoding()`
`FileMakingHeaderInfo`	`getFileMakingHeaderInfo()`
`String`	`getLineSeparator()`
`FileMakingOption`	`headerInfo(List<String> columnNameList)` Set the header info with the list of column name.
`boolean`	`isQuoteMinimally()`
`boolean`	`isSuppressValueCountCheck()`
`FileMakingOption`	`quoteMinimally()` Quote values minimally (if it needs).
`FileMakingOption`	`separateByCrLf()` Separate line by CR + LF.
`FileMakingOption`	`separateByLf()` Separate line by LF.
`void`	`setDelimiter(String delimiter)`
`void`	`setEncoding(String encoding)`
`void`	`setFileMakingHeaderInfo(FileMakingHeaderInfo headerInfo)`
`void`	`setLineSeparator(String lineSeparator)`
`FileMakingOption`	`suppressValueCountCheck()` Suppress the value count check.
`String`	`toString()`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - _delimiter
```
protected String _delimiter
```
    The delimiter of data. (Required)
  - _encoding
```
protected String _encoding
```
    The encoding for the file. (Required)
  - _lineSeparator
```
protected String _lineSeparator
```
    The line separator for the file. (NotRequired)
  - _quoteMinimally
```
protected boolean _quoteMinimally
```
    Does it quote values minimally? (NotRequired)
  - _suppressValueCountCheck
```
protected boolean _suppressValueCountCheck
```
    Does it suppress value count check? (NotRequired)
  - _headerInfo
```
protected FileMakingHeaderInfo _headerInfo
```
    The header info of file-making. (NotRequired)
- コンストラクタの詳細
  - FileMakingOption
```
public FileMakingOption()
```
- メソッドの詳細
  - delimitateByComma
```
public FileMakingOption delimitateByComma()
```
    Delimitate by Comma.
    
    戻り値:
    
    this. (NotNull)
  - delimitateByTab
```
public FileMakingOption delimitateByTab()
```
    Delimitate by Tab.
    
    戻り値:
    
    this. (NotNull)
  - encodeAsUTF8
```
public FileMakingOption encodeAsUTF8()
```
    Encode file as UTF-8.
    
    戻り値:
    
    this. (NotNull)
  - encodeAsWindows31J
```
public FileMakingOption encodeAsWindows31J()
```
    Encode file as Windows-31J.
    
    戻り値:
    
    this. (NotNull)
  - separateByCrLf
```
public FileMakingOption separateByCrLf()
```
    Separate line by CR + LF.
    
    戻り値:
    
    this. (NotNull)
  - separateByLf
```
public FileMakingOption separateByLf()
```
    Separate line by LF.
    
    戻り値:
    
    this. (NotNull)
  - quoteMinimally
```
public FileMakingOption quoteMinimally()
```
    Quote values minimally (if it needs).
    
    戻り値:
    
    this. (NotNull)
  - suppressValueCountCheck
```
public FileMakingOption suppressValueCountCheck()
```
    Suppress the value count check. (compare with header's column count)
    
    戻り値:
    
    this. (NotNull)
  - headerInfo
```
public FileMakingOption headerInfo(List<String> columnNameList)
```
    Set the header info with the list of column name.
    
    パラメータ:
    
    columnNameList - The list of column name. (NullAllowed: means no header)
    
    戻り値:
    
    this. (NotNull)
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - getDelimiter
```
public String getDelimiter()
```
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
  - getEncoding
```
public String getEncoding()
```
  - setEncoding
```
public void setEncoding(String encoding)
```
  - getLineSeparator
```
public String getLineSeparator()
```
  - setLineSeparator
```
public void setLineSeparator(String lineSeparator)
```
  - isQuoteMinimally
```
public boolean isQuoteMinimally()
```
  - isSuppressValueCountCheck
```
public boolean isSuppressValueCountCheck()
```
  - getFileMakingHeaderInfo
```
public FileMakingHeaderInfo getFileMakingHeaderInfo()
```
  - setFileMakingHeaderInfo
```
public void setFileMakingHeaderInfo(FileMakingHeaderInfo headerInfo)
```

クラス FileMakingOption

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

_delimiter

_encoding

_lineSeparator

_quoteMinimally

_suppressValueCountCheck

_headerInfo

コンストラクタの詳細

FileMakingOption

メソッドの詳細

delimitateByComma

delimitateByTab

encodeAsUTF8

encodeAsWindows31J

separateByCrLf

separateByLf

quoteMinimally

suppressValueCountCheck

headerInfo

toString

getDelimiter

setDelimiter

getEncoding

setEncoding

getLineSeparator

setLineSeparator

isQuoteMinimally

isSuppressValueCountCheck

getFileMakingHeaderInfo

setFileMakingHeaderInfo