jp.sf.orangesignal.csv
クラス CsvConfig

java.lang.Object
  jp.sf.orangesignal.csv.CsvConfig

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

Serializable, Cloneable

public class CsvConfig
extends Object
implements Serializable, Cloneable

区切り文字形式情報を提供します。

このクラスは、区切り文字や囲み文字、エスケープ文字など CSV 形式に関する設定情報を管理します。

作成者:

杉澤 浩二

関連項目:

直列化された形式

フィールドの概要

static char	DEFAULT_ESCAPE デフォルトのエスケープ文字です。
static char	DEFAULT_QUOTE デフォルトの囲み文字です。
static QuotePolicy	DEFAULT_QUOTE_POLICY デフォルトの囲み文字出力方法の種類です。
static char	DEFAULT_SEPARATOR デフォルトの区切り文字です。
static int	DEFAULT_SKIP_LINES デフォルトの先頭から読飛ばす論理行数です。

コンストラクタの概要

CsvConfig()
デフォルトコンストラクタです。

CsvConfig(char separator)
コンストラクタです。

CsvConfig(char separator, char quote, char escape)
コンストラクタです。

CsvConfig(char separator, char quote, char escape, boolean quoteDisabled, boolean escapeDisabled)
コンストラクタです。

メソッドの概要

CsvConfig	clone()
String	getBreakString() 値の改行文字列を置換える文字列を返します。
char	getEscape() エスケープ文字を返します。
Pattern[]	getIgnoreLinePatterns() 無視する行の正規表現パターン群を返します。
String	getLineSeparator() データ出力時の改行文字列を返します。
String	getNullString() 値がないことを表す文字列を返します。
char	getQuote() 囲み文字を返します。
QuotePolicy	getQuotePolicy() 囲み文字出力方法の種類を返します。
char	getSeparator() 区切り文字を返します。
int	getSkipLines() ファイルの先頭から読飛ばす行数を返します。
boolean	isEscapeDisabled() エスケープ文字を無効にするかどうかを返します。
boolean	isIgnoreCaseNullString() 値がないことを表す文字列の大文字と小文字を区別するかどうかを返します。
boolean	isIgnoreEmptyLines() 空行を無視するかどうかを返します。
boolean	isIgnoreLeadingWhitespaces() 値より前のホワイトスペースを除去するかどうかを返します。
boolean	isIgnoreTrailingWhitespaces() 値より後ろのホワイトスペースを除去するかどうかを返します。
boolean	isQuoteDisabled() 囲み文字を無効にするかどうかを返します。
boolean	isUtf8bomPolicy() UTF-8 エンコーディングでの出力時に BOM (Byte Order Mark) を付与するかどうかを返します。
void	setBreakString(String breakString) 値の改行文字列を置換える文字列を設定します。
void	setEscape(char escape) エスケープ文字を設定します。
void	setEscapeDisabled(boolean disabled) エスケープ文字を無効にするかどうかを設定します。
void	setIgnoreCaseNullString(boolean ignoreCaseNullString) 値がないことを表す文字列の大文字と小文字を区別するかどうかを設定します。
void	setIgnoreEmptyLines(boolean ignore) 空行を無視するかどうかを設定します。
void	setIgnoreLeadingWhitespaces(boolean ignore) 値より前のホワイトスペースを除去するかどうかを設定します。
void	setIgnoreLinePatterns(Pattern... ignoreLinePatterns) 無視する行の正規表現パターン群を設定します。
void	setIgnoreTrailingWhitespaces(boolean ignore) 値より後ろのホワイトスペースを除去するかどうかを設定します。
void	setLineSeparator(String lineSeparator) データ出力時の改行文字列を設定します。
void	setNullString(String nullString) 値がないことを表す文字列を設定します。
void	setNullString(String nullString, boolean ignoreCase) 値がないことを表す文字列を設定します。
void	setQuote(char quote) 囲み文字を設定します。
void	setQuoteDisabled(boolean disabled) 囲み文字を無効にするかどうかを設定します。
void	setQuotePolicy(QuotePolicy quotePolicy) 囲み文字出力方法の種類を設定します。
void	setSeparator(char separator) 区切り文字を設定します。
void	setSkipLines(int skipLines) ファイルの先頭から読飛ばす行数を設定します。
void	setUtf8bomPolicy(boolean utf8bomPolicy) UTF-8 エンコーディングでの出力時に BOM (Byte Order Mark) を付与するかどうかを設定します。
void	validate() 区切り文字および囲み文字、エスケープ文字の組合せを検証します。

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

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

フィールドの詳細

DEFAULT_SEPARATOR

public static final char DEFAULT_SEPARATOR

デフォルトの区切り文字です。

関連項目:

定数フィールド値

DEFAULT_QUOTE

public static final char DEFAULT_QUOTE

デフォルトの囲み文字です。

関連項目:

定数フィールド値

DEFAULT_ESCAPE

public static final char DEFAULT_ESCAPE

デフォルトのエスケープ文字です。

関連項目:

定数フィールド値

DEFAULT_SKIP_LINES

public static final int DEFAULT_SKIP_LINES

デフォルトの先頭から読飛ばす論理行数です。

関連項目:

定数フィールド値

DEFAULT_QUOTE_POLICY

public static final QuotePolicy DEFAULT_QUOTE_POLICY

デフォルトの囲み文字出力方法の種類です。

導入されたバージョン:

1.1

コンストラクタの詳細

CsvConfig

public CsvConfig()

デフォルトコンストラクタです。

CsvConfig

public CsvConfig(char separator)

コンストラクタです。

パラメータ:

separator - 区切り文字

CsvConfig

public CsvConfig(char separator,
                 char quote,
                 char escape)

コンストラクタです。

パラメータ:

separator - 区切り文字

quote - 囲み文字

escape - エスケープ文字

例外:

IllegalArgumentException - quote または escape が separator と同一文字の場合

CsvConfig

public CsvConfig(char separator,
                 char quote,
                 char escape,
                 boolean quoteDisabled,
                 boolean escapeDisabled)

コンストラクタです。

パラメータ:

separator - 区切り文字

quote - 囲み文字

escape - エスケープ文字

quoteDisabled - 囲み文字を無効にするかどうか

escapeDisabled - エスケープ文字を無効にするかどうか

例外:

IllegalArgumentException - quote または escape が separator と同一文字の場合

メソッドの詳細

validate

public void validate()
              throws IllegalArgumentException

区切り文字および囲み文字、エスケープ文字の組合せを検証します。

例外:

IllegalArgumentException - 区切り文字および囲み文字、エスケープ文字の組合せが不正な場合

getSeparator

public char getSeparator()

区切り文字を返します。

戻り値:

区切り文字

setSeparator

public void setSeparator(char separator)

区切り文字を設定します。

パラメータ:

separator - 区切り文字

getQuote

public char getQuote()

囲み文字を返します。

戻り値:

囲み文字

setQuote

public void setQuote(char quote)

囲み文字を設定します。

パラメータ:

quote - 囲み文字

getEscape

public char getEscape()

エスケープ文字を返します。

戻り値:

エスケープ文字

setEscape

public void setEscape(char escape)

エスケープ文字を設定します。

パラメータ:

escape - エスケープ文字

isQuoteDisabled

public boolean isQuoteDisabled()

囲み文字を無効にするかどうかを返します。

戻り値:

囲み文字を無効にするかどうか

setQuoteDisabled

public void setQuoteDisabled(boolean disabled)

囲み文字を無効にするかどうかを設定します。

パラメータ:

disabled - 囲み文字を無効にするかどうか

isEscapeDisabled

public boolean isEscapeDisabled()

エスケープ文字を無効にするかどうかを返します。

戻り値:

エスケープ文字を無効にするかどうか

setEscapeDisabled

public void setEscapeDisabled(boolean disabled)

エスケープ文字を無効にするかどうかを設定します。

パラメータ:

disabled - エスケープ文字を無効にするかどうか

getBreakString

public String getBreakString()

値の改行文字列を置換える文字列を返します。

戻り値:

値の改行文字列を置換える文字列

setBreakString

public void setBreakString(String breakString)

値の改行文字列を置換える文字列を設定します。

パラメータ:

breakString - 値の改行文字列を置換える文字列

getNullString

public String getNullString()

値がないことを表す文字列を返します。

戻り値:

値がないことを表す文字列

setNullString

public void setNullString(String nullString)

値がないことを表す文字列を設定します。

パラメータ:

nullString - 値がないことを表す文字列

setNullString

public void setNullString(String nullString,
                          boolean ignoreCase)

値がないことを表す文字列を設定します。

パラメータ:

nullString - 値がないことを表す文字列

ignoreCase - 大文字と小文字を区別するかどうか

isIgnoreCaseNullString

public boolean isIgnoreCaseNullString()

値がないことを表す文字列の大文字と小文字を区別するかどうかを返します。

戻り値:

値がないことを表す文字列の大文字と小文字を区別するかどうか

setIgnoreCaseNullString

public void setIgnoreCaseNullString(boolean ignoreCaseNullString)

値がないことを表す文字列の大文字と小文字を区別するかどうかを設定します。

パラメータ:

ignoreCaseNullString - 値がないことを表す文字列の大文字と小文字を区別するかどうか

導入されたバージョン:

1.2.2

isIgnoreLeadingWhitespaces

public boolean isIgnoreLeadingWhitespaces()

値より前のホワイトスペースを除去するかどうかを返します。

戻り値:

値より前のホワイトスペースを除去するかどうか

setIgnoreLeadingWhitespaces

public void setIgnoreLeadingWhitespaces(boolean ignore)

値より前のホワイトスペースを除去するかどうかを設定します。

パラメータ:

ignore - 値より前のホワイトスペースを除去するかどうか

関連項目:

Character.isWhitespace(char)

isIgnoreTrailingWhitespaces

public boolean isIgnoreTrailingWhitespaces()

値より後ろのホワイトスペースを除去するかどうかを返します。

戻り値:

値より後ろのホワイトスペースを除去するかどうか

setIgnoreTrailingWhitespaces

public void setIgnoreTrailingWhitespaces(boolean ignore)

値より後ろのホワイトスペースを除去するかどうかを設定します。

パラメータ:

ignore - 値より後ろのホワイトスペースを除去するかどうか

関連項目:

Character.isWhitespace(char)

isIgnoreEmptyLines

public boolean isIgnoreEmptyLines()

空行を無視するかどうかを返します。

戻り値:

空行を無視するかどうか

setIgnoreEmptyLines

public void setIgnoreEmptyLines(boolean ignore)

空行を無視するかどうかを設定します。

パラメータ:

ignore - 空行を無視するかどうか

getIgnoreLinePatterns

public Pattern[] getIgnoreLinePatterns()

無視する行の正規表現パターン群を返します。

戻り値:

無視する行の正規表現パターン群

setIgnoreLinePatterns

public void setIgnoreLinePatterns(Pattern... ignoreLinePatterns)

無視する行の正規表現パターン群を設定します。

パラメータ:

ignoreLinePatterns - 無視する行の正規表現パターン群

getSkipLines

public int getSkipLines()

ファイルの先頭から読飛ばす行数を返します。

戻り値:

ファイルの先頭から読飛ばす行数

setSkipLines

public void setSkipLines(int skipLines)

ファイルの先頭から読飛ばす行数を設定します。

パラメータ:

skipLines - ファイルの先頭から読飛ばす行数

getLineSeparator

public String getLineSeparator()

データ出力時の改行文字列を返します。

戻り値:

データ出力時の改行文字列

setLineSeparator

public void setLineSeparator(String lineSeparator)

データ出力時の改行文字列を設定します。

パラメータ:

lineSeparator - データ出力時の改行文字列

getQuotePolicy

public QuotePolicy getQuotePolicy()

囲み文字出力方法の種類を返します。

戻り値:

囲み文字出力方法の種類

導入されたバージョン:

1.1

setQuotePolicy

public void setQuotePolicy(QuotePolicy quotePolicy)

囲み文字出力方法の種類を設定します。

パラメータ:

quotePolicy - 囲み文字出力方法の種類

例外:

IllegalArgumentException - quotePolicy が null の場合

導入されたバージョン:

1.1

isUtf8bomPolicy

public boolean isUtf8bomPolicy()

UTF-8 エンコーディングでの出力時に BOM (Byte Order Mark) を付与するかどうかを返します。

戻り値:

UTF-8 エンコーディングでの出力時に BOM (Byte Order Mark) を付与するかどうか

導入されたバージョン:

1.2.9

setUtf8bomPolicy

public void setUtf8bomPolicy(boolean utf8bomPolicy)

UTF-8 エンコーディングでの出力時に BOM (Byte Order Mark) を付与するかどうかを設定します。

パラメータ:

utf8bomPolicy - UTF-8 エンコーディングでの出力時に BOM (Byte Order Mark) を付与するかどうか

導入されたバージョン:

1.2.9

clone

public CsvConfig clone()

オーバーライド:

クラス Object 内の clone

導入されたバージョン:

1.1