com.orangesignal.csv.io

クラス CsvBeanWriter<T>

java.lang.Object

com.orangesignal.csv.io.CsvBeanWriter<T>

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

Closeable, Flushable, AutoCloseable

public class CsvBeanWriter<T>
extends Object
implements Closeable, Flushable

Java プログラム要素で区切り文字形式データアクセスを行う区切り文字形式出力ストリームを提供します。

導入されたバージョン:

1.4.0

作成者:

Koji Sugisawa

コンストラクタの概要

コンストラクタ

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

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	close()
void	flush()
CsvBeanTemplate<T>	getTemplate() Java プログラム要素操作の簡素化ヘルパーを返します。
static <T> CsvBeanWriter<T>	newInstance(CsvWriter writer, Class<T> type) 新しい CsvBeanWriter のインスタンスを返します。
static <T> CsvBeanWriter<T>	newInstance(CsvWriter writer, Class<T> type, boolean header) 新しい CsvBeanWriter のインスタンスを返します。
static <T> CsvBeanWriter<T>	newInstance(CsvWriter writer, CsvBeanTemplate<T> template) 新しい CsvBeanWriter のインスタンスを返します。
static <T> CsvBeanWriter<T>	newInstance(CsvWriter writer, CsvBeanTemplate<T> template, boolean header) 新しい CsvBeanWriter のインスタンスを返します。
boolean	write(T bean) 指定された Java プログラム要素を区切り文字形式で書き込みます。
void	writeHeader() 可能であれば項目名を書き込みます。

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

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

コンストラクタの詳細

CsvBeanWriter

public CsvBeanWriter(CsvWriter writer,
             Class<T> type)

指定された区切り文字形式出力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。

パラメータ:

writer - 区切り文字形式出力ストリーム

type - Java プログラム要素の型

例外:

IllegalArgumentException - writer または type が null の場合。

CsvBeanWriter

public CsvBeanWriter(CsvWriter writer,
             Class<T> type,
             boolean header)

指定された区切り文字形式出力ストリームと Java プログラム要素の型を使用して、このクラスを構築するコンストラクタです。

パラメータ:

writer - 区切り文字形式出力ストリーム

type - Java プログラム要素の型

header - 区切り文字形式データの列見出し (ヘッダ) 行を出力するかどうか

例外:

IllegalArgumentException - writer または type が null の場合。

導入されたバージョン:

2.1

CsvBeanWriter

public CsvBeanWriter(CsvWriter writer,
             CsvBeanTemplate<T> template)

指定された区切り文字形式出力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。

パラメータ:

writer - 区切り文字形式出力ストリーム

template - Java プログラム要素操作の簡素化ヘルパー

例外:

IllegalArgumentException - writer または template が null の場合。

CsvBeanWriter

public CsvBeanWriter(CsvWriter writer,
             CsvBeanTemplate<T> template,
             boolean header)

指定された区切り文字形式出力ストリームと Java プログラム要素操作の簡素化ヘルパーを使用して、このクラスを構築するコンストラクタです。

パラメータ:

writer - 区切り文字形式出力ストリーム

template - Java プログラム要素操作の簡素化ヘルパー

header - 区切り文字形式データの列見出し (ヘッダ) 行を出力するかどうか

例外:

IllegalArgumentException - writer または template が null の場合。

導入されたバージョン:

2.1

メソッドの詳細

newInstance

public static <T> CsvBeanWriter<T> newInstance(CsvWriter writer,
                               Class<T> type)

新しい CsvBeanWriter のインスタンスを返します。 このメソッドは利便性のために提供しています。

パラメータ:

writer - 区切り文字形式出力ストリーム

type - Java プログラム要素の型

戻り値:

新しい CsvBeanWriter のインスタンス

例外:

IllegalArgumentException - writer または type が null の場合。

newInstance

public static <T> CsvBeanWriter<T> newInstance(CsvWriter writer,
                               Class<T> type,
                               boolean header)

新しい CsvBeanWriter のインスタンスを返します。 このメソッドは利便性のために提供しています。

パラメータ:

writer - 区切り文字形式出力ストリーム

type - Java プログラム要素の型

header - 区切り文字形式データの列見出し (ヘッダ) 行を出力するかどうか

戻り値:

新しい CsvBeanWriter のインスタンス

例外:

IllegalArgumentException - writer または type が null の場合。

導入されたバージョン:

2.1

newInstance

public static <T> CsvBeanWriter<T> newInstance(CsvWriter writer,
                               CsvBeanTemplate<T> template)

新しい CsvBeanWriter のインスタンスを返します。 このメソッドは利便性のために提供しています。

パラメータ:

writer - 区切り文字形式出力ストリーム

template - Java プログラム要素操作の簡素化ヘルパー

戻り値:

新しい CsvBeanWriter のインスタンス

例外:

IllegalArgumentException - writer または template が null の場合。

newInstance

public static <T> CsvBeanWriter<T> newInstance(CsvWriter writer,
                               CsvBeanTemplate<T> template,
                               boolean header)

新しい CsvBeanWriter のインスタンスを返します。 このメソッドは利便性のために提供しています。

パラメータ:

writer - 区切り文字形式出力ストリーム

template - Java プログラム要素操作の簡素化ヘルパー

header - 区切り文字形式データの列見出し (ヘッダ) 行を出力するかどうか

戻り値:

新しい CsvBeanWriter のインスタンス

例外:

IllegalArgumentException - writer または template が null の場合。

導入されたバージョン:

2.1

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 - 入出力エラーが発生した場合

write

public boolean write(T bean)
              throws IOException

指定された Java プログラム要素を区切り文字形式で書き込みます。 null が指定された場合は空行が書き込まれます。

パラメータ:

bean - 書き込む Java プログラム要素。または null

戻り値:

データの出力を行った場合は true それ以外の場合 (フィルタにより書き込みがスキップされた場合) は false

例外:

IOException - 入出力エラーが発生した場合

getTemplate

public CsvBeanTemplate<T> getTemplate()

Java プログラム要素操作の簡素化ヘルパーを返します。

戻り値:

Java プログラム要素操作の簡素化ヘルパー

導入されたバージョン:

2.1