com.orangesignal.csv.io

クラス CsvColumnNameMapWriter

java.lang.Object

com.orangesignal.csv.io.CsvColumnNameMapWriter

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

Closeable, Flushable, AutoCloseable

public class CsvColumnNameMapWriter
extends Object
implements Closeable, Flushable

項目名と項目値のマップで区切り文字形式データアクセスを行う区切り文字形式出力ストリームを提供します。

導入されたバージョン:

1.4.0

作成者:

Koji Sugisawa

コンストラクタの概要

コンストラクタ

コンストラクタと説明
CsvColumnNameMapWriter(CsvWriter writer) 指定された区切り文字形式出力ストリームを使用して、このクラスを構築するコンストラクタです。
CsvColumnNameMapWriter(CsvWriter writer, boolean header) 指定された区切り文字形式出力ストリームを使用して、このクラスを構築するコンストラクタです。
CsvColumnNameMapWriter(CsvWriter writer, List<String> columnNames) 指定された区切り文字形式出力ストリームと項目名のリストを使用して、このクラスを構築するコンストラクタです。
CsvColumnNameMapWriter(CsvWriter writer, List<String> columnNames, boolean header) 指定された区切り文字形式出力ストリームと項目名のリストを使用して、このクラスを構築するコンストラクタです。

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	close()
void	flush()
CsvNamedValueFilter	getFilter() 区切り文字形式データフィルタを返します。
void	setFilter(CsvNamedValueFilter filter) 区切り文字形式データフィルタを設定します。
boolean	write(Map<String,String> map) 指定された項目名と項目値のマップを書き込みます。
void	writeHeader(Map<String,String> map) 可能であれば項目名を書き込みます。

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

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

コンストラクタの詳細

CsvColumnNameMapWriter

public CsvColumnNameMapWriter(CsvWriter writer)

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

パラメータ:

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

例外:

IllegalArgumentException - writer が null の場合。

CsvColumnNameMapWriter

public CsvColumnNameMapWriter(CsvWriter writer,
                      boolean header)

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

パラメータ:

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

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

例外:

IllegalArgumentException - writer が null の場合。

導入されたバージョン:

2.1

CsvColumnNameMapWriter

public CsvColumnNameMapWriter(CsvWriter writer,
                      List<String> columnNames)

指定された区切り文字形式出力ストリームと項目名のリストを使用して、このクラスを構築するコンストラクタです。

パラメータ:

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

columnNames - 項目名のリスト

例外:

IllegalArgumentException - writer が null の場合。

CsvColumnNameMapWriter

public CsvColumnNameMapWriter(CsvWriter writer,
                      List<String> columnNames,
                      boolean header)

指定された区切り文字形式出力ストリームと項目名のリストを使用して、このクラスを構築するコンストラクタです。

パラメータ:

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

columnNames - 項目名のリスト

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

例外:

IllegalArgumentException - writer が 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(Map<String,String> map)
                 throws IOException

可能であれば項目名を書き込みます。項目名が既に書き込まれている場合、このメソッドは何も行いません。

パラメータ:

map - 項目名と項目値のマップ

例外:

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

write

public boolean write(Map<String,String> map)
              throws IOException

指定された項目名と項目値のマップを書き込みます。項目名の書き込みが必要な場合は自動的に書き込みが行われます。

パラメータ:

map - 項目名と項目値のマップ

戻り値:

区切り文字形式データフィルタによって書き込みが行われなかった場合は false それ以外の場合は true

例外:

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

getFilter

public CsvNamedValueFilter getFilter()

区切り文字形式データフィルタを返します。

戻り値:

区切り文字形式データフィルタ。または null

setFilter

public void setFilter(CsvNamedValueFilter filter)

区切り文字形式データフィルタを設定します。

パラメータ:

filter - 区切り文字形式データフィルタ