CsvEntityWriter (OrangeSignal CSV 2.2.2-SNAPSHOT API)

java.lang.Object
- com.orangesignal.csv.io.CsvEntityWriter<T>

すべての実装されたインタフェース:

Closeable, Flushable, AutoCloseable
```
public class CsvEntityWriter<T>
extends Object
implements Closeable, Flushable
```
区切り文字形式データ注釈要素 CsvEntity で注釈付けされた Java プログラム要素で区切り文字形式データアクセスを行う区切り文字形式出力ストリームを提供します。

導入されたバージョン:

1.4.0

作成者:

Koji Sugisawa

コンストラクタの概要

コンストラクタ
コンストラクタと説明
`CsvEntityWriter(CsvWriter writer, Class<T> entityClass)` 指定された区切り文字形式出力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。
`CsvEntityWriter(CsvWriter writer, Class<T> entityClass, boolean disableWriteHeader)` 指定された区切り文字形式出力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。
`CsvEntityWriter(CsvWriter writer, CsvEntityTemplate<T> template)` 指定された区切り文字形式出力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。
`CsvEntityWriter(CsvWriter writer, CsvEntityTemplate<T> template, boolean disableWriteHeader)` 指定された区切り文字形式出力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`void`	`close()`
`void`	`flush()`
`CsvEntityTemplate<T>`	`getTemplate()` Java プログラム要素操作の簡素化ヘルパーを返します。
`boolean`	`isDisableWriteHeader()` 区切り文字形式データの列見出し (ヘッダ) 行の出力が無効化されているかどうかを返します。
`static <T> CsvEntityWriter<T>`	`newInstance(CsvWriter writer, Class<T> entityClass)` 新しい `CsvEntityWriter` のインスタンスを返します。
`static <T> CsvEntityWriter<T>`	`newInstance(CsvWriter writer, Class<T> entityClass, boolean disableWriteHeader)` 新しい `CsvEntityWriter` のインスタンスを返します。
`static <T> CsvEntityWriter<T>`	`newInstance(CsvWriter writer, CsvEntityTemplate<T> template)` 新しい `CsvEntityWriter` のインスタンスを返します。
`static <T> CsvEntityWriter<T>`	`newInstance(CsvWriter writer, CsvEntityTemplate<T> template, boolean disableWriteHeader)` 新しい `CsvEntityWriter` のインスタンスを返します。
`boolean`	`write(T entity)` 指定された Java プログラム要素を区切り文字形式で書き込みます。
`void`	`writeHeader()` 可能であれば項目名を書き込みます。

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

- コンストラクタの詳細
  - CsvEntityWriter
```
public CsvEntityWriter(CsvWriter writer,
               Class<T> entityClass)
```
    指定された区切り文字形式出力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。
    
    パラメータ:
    writer - 区切り文字形式出力ストリーム
    entityClass - 区切り文字形式データ注釈要素 CsvEntity で注釈付けされた Java プログラム要素の型
    
    例外:
    
    IllegalArgumentException - writer または entityClass が null の場合。
  - CsvEntityWriter
```
public CsvEntityWriter(CsvWriter writer,
               Class<T> entityClass,
               boolean disableWriteHeader)
```
    指定された区切り文字形式出力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。
    
    パラメータ:
    writer - 区切り文字形式出力ストリーム
    entityClass - 区切り文字形式データ注釈要素 CsvEntity で注釈付けされた Java プログラム要素の型
    disableWriteHeader - 区切り文字形式データの列見出し (ヘッダ) 行の出力を無効化するかどうか
    
    例外:
    
    IllegalArgumentException - writer または entityClass が null の場合。
    導入されたバージョン:
    
    2.2
  - CsvEntityWriter
```
public CsvEntityWriter(CsvWriter writer,
               CsvEntityTemplate<T> template)
```
    指定された区切り文字形式出力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。
    
    パラメータ:
    writer - 区切り文字形式出力ストリーム
    template - Java プログラム要素操作の簡素化ヘルパー
    
    例外:
    
    IllegalArgumentException - writer または template が null の場合。
  - CsvEntityWriter
```
public CsvEntityWriter(CsvWriter writer,
               CsvEntityTemplate<T> template,
               boolean disableWriteHeader)
```
    指定された区切り文字形式出力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。
    
    パラメータ:
    writer - 区切り文字形式出力ストリーム
    template - Java プログラム要素操作の簡素化ヘルパー
    disableWriteHeader - 区切り文字形式データの列見出し (ヘッダ) 行の出力を無効化するかどうか
    
    例外:
    
    IllegalArgumentException - writer または template が null の場合。
    導入されたバージョン:
    
    2.2
- メソッドの詳細
  - newInstance
```
public static <T> CsvEntityWriter<T> newInstance(CsvWriter writer,
                                 Class<T> entityClass)
```
    新しい CsvEntityWriter のインスタンスを返します。このメソッドは利便性のために提供しています。
    
    パラメータ:
    writer - 区切り文字形式出力ストリーム
    entityClass - 区切り文字形式データ注釈要素 CsvEntity で注釈付けされた Java プログラム要素の型
    
    戻り値:
    新しい CsvEntityWriter のインスタンス
    
    例外:
    
    IllegalArgumentException - writer または entityClass が null の場合。
  - newInstance
```
public static <T> CsvEntityWriter<T> newInstance(CsvWriter writer,
                                 Class<T> entityClass,
                                 boolean disableWriteHeader)
```
    新しい CsvEntityWriter のインスタンスを返します。このメソッドは利便性のために提供しています。
    
    パラメータ:
    writer - 区切り文字形式出力ストリーム
    entityClass - 区切り文字形式データ注釈要素 CsvEntity で注釈付けされた Java プログラム要素の型
    disableWriteHeader - 区切り文字形式データの列見出し (ヘッダ) 行の出力を無効化するかどうか
    
    戻り値:
    新しい CsvEntityWriter のインスタンス
    
    例外:
    
    IllegalArgumentException - writer または entityClass が null の場合。
    導入されたバージョン:
    
    2.2
  - newInstance
```
public static <T> CsvEntityWriter<T> newInstance(CsvWriter writer,
                                 CsvEntityTemplate<T> template)
```
    新しい CsvEntityWriter のインスタンスを返します。このメソッドは利便性のために提供しています。
    
    パラメータ:
    writer - 区切り文字形式出力ストリーム
    template - Java プログラム要素操作の簡素化ヘルパー
    
    戻り値:
    新しい CsvEntityWriter のインスタンス
    
    例外:
    
    IllegalArgumentException - writer または template が null の場合。
  - newInstance
```
public static <T> CsvEntityWriter<T> newInstance(CsvWriter writer,
                                 CsvEntityTemplate<T> template,
                                 boolean disableWriteHeader)
```
    新しい CsvEntityWriter のインスタンスを返します。このメソッドは利便性のために提供しています。
    
    パラメータ:
    writer - 区切り文字形式出力ストリーム
    template - Java プログラム要素操作の簡素化ヘルパー
    disableWriteHeader - 区切り文字形式データの列見出し (ヘッダ) 行の出力を無効化するかどうか
    
    戻り値:
    新しい CsvEntityWriter のインスタンス
    
    例外:
    
    IllegalArgumentException - writer または template が null の場合。
    導入されたバージョン:
    
    2.2
  - flush
```
public void flush()
           throws IOException
```
    定義:
    
    flush インタフェース内 Flushable
    
    例外:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    定義:
    
    close インタフェース内 Closeable
    
    定義:
    
    close インタフェース内 AutoCloseable
    
    例外:
    
    IOException
  - writeHeader
```
public void writeHeader()
                 throws IOException
```
    可能であれば項目名を書き込みます。項目名が既に書き込まれている場合や、区切り文字形式データの列見出し (ヘッダ) 行の出力が無効化されている場合、このメソッドは何も行いません。
    
    例外:
    
    IOException - 入出力エラーが発生した場合
    関連項目:
    #isDisableWriteHeader()}
  - write
```
public boolean write(T entity)
              throws IOException
```
    指定された Java プログラム要素を区切り文字形式で書き込みます。 null が指定された場合は空行が書き込まれます。
    
    パラメータ:
    entity - 書き込む Java プログラム要素。または null
    
    戻り値:
    データの出力を行った場合は true それ以外の場合 (フィルタにより書き込みがスキップされた場合) は false
    
    例外:
    
    CsvColumnException - 区切り文字形式のデータ項目の検証操作実行中にエラーが発生した場合
    
    IOException - 入出力エラーが発生した場合
  - getTemplate
```
public CsvEntityTemplate<T> getTemplate()
```
    Java プログラム要素操作の簡素化ヘルパーを返します。
    
    戻り値:
    Java プログラム要素操作の簡素化ヘルパー
    導入されたバージョン:
    
    2.1
  - isDisableWriteHeader
```
public boolean isDisableWriteHeader()
```
    区切り文字形式データの列見出し (ヘッダ) 行の出力が無効化されているかどうかを返します。
    
    戻り値:
    区切り文字形式データの列見出し (ヘッダ) 行の出力が無効化されているかどうか
    導入されたバージョン:
    
    2.2

クラス CsvEntityWriter<T>

コンストラクタの概要

メソッドの概要

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

コンストラクタの詳細

CsvEntityWriter

CsvEntityWriter

CsvEntityWriter

CsvEntityWriter

メソッドの詳細

newInstance

newInstance

newInstance

newInstance

flush

close

writeHeader

write

getTemplate

isDisableWriteHeader