com.github.mygreen.supercsv.annotation.format

注釈型 CsvBooleanFormat

@Target(value={FIELD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
public @interface CsvBooleanFormat

boolean/Boolean型の書式を定義するためのアノテーションです。

基本的な使い方

• 属性readForTrue()、readForFalse()で、読み込み時のtrueまたはfalseと判定する候補の値を指定します。
• 属性writeAsTrue()、writeAsFalse()で、書き込み時のtrueまたはfalse値に該当する文字を指定します。
• 属性ignoreCase()で、読み込み時に大文字・小文字の区別なく候補の値と比較するか指定します。

 @CsvBean
 public class SampleCsv {
     
     // boolean型の読み込み時のtrueとfalseの値の変換規則を指定します。
     @CsvColumn(number=1)
     @CsvBooleanFormat(
           readForTrue={"○", "有効", "レ"}, readForFalse={"×", "無効", "-", ""},
           writeAsTrue="○", writeAsFalse="×")
     private boolean availaled;
     
     // 読み込み時の大文字・小文字の区別を行わない
     @CsvColumn(number=2, label="チェック")
     @CsvBooleanFormat(readForTrue={"OK"}, readForFalse={"NO"}, ignoreCase=true)
     private Boolean checked;
     
     // getter/setterは省略
 }
 

バージョン:

2.0

作成者:

T.TSUCHIE

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
boolean	failToFalse 読み込み時に readForTrue()、readForFalse() で指定した候補の値と一致しない場合、値をfalseとして読み込み込むか指定します。
boolean	ignoreCase 読み込み時に、大文字・小文字を区別なく候補の値と比較して判定するか指定します。
String	message エラー時のメッセージを指定します。
String[]	readForFalse 読み込み時にfalse とする候補を指定します。
String[]	readForTrue 読み込み時にtrue とする候補を指定します。
String	writeAsFalse 書き込み時にfalseの値を表現する値を指定します。
String	writeAsTrue 書き込み時にtrueの値を表現する値を指定します。

要素の詳細

readForTrue

public abstract String[] readForTrue

読み込み時にtrue とする候補を指定します。

readForFalse() と重複する値がある場合は、readForTrue() の値が優先されます。

戻り値:

trueとして読み込む候補。

デフォルト:

{"true", "1", "yes", "on", "y", "t"}

readForFalse

public abstract String[] readForFalse

読み込み時にfalse とする候補を指定します。

readForTrue() と重複する値がある場合は、readForTrue() の値が優先されます。

戻り値:

falseとして読み込む候補。

デフォルト:

{"false", "0", "no", "off", "f", "n"}

writeAsTrue

public abstract String writeAsTrue

書き込み時にtrueの値を表現する値を指定します。

`true`以外の`○`など他の値として出力したい場合に指定します。

使用可能なメッセージ中の変数は下記の通りです。

• lineNumber : カラムの値に改行が含まれている場合を考慮した実際の行番号です。1から始まります。
• rowNumber : CSVの行番号です。1から始まります。
• columnNumber : CSVの列番号です。1から始まります。
• label : カラムの見出し名です。
• validatedValue : 実際のカラムの値です。
• ignoreCase : アノテーションの属性ignoreCase()の値です。
• failToFalse : アノテーションの属性failToFalse()の値です。
• trueValues : アノテーションの属性readForTrue()をLinkedHashSet型にした値です。
• falseValues : アノテーションの属性readForFalse()をLinkedHashSet型にした値です。

戻り値:

trueの値の代替として出力される値。

デフォルト:

"true"

writeAsFalse

public abstract String writeAsFalse

書き込み時にfalseの値を表現する値を指定します。

`false`以外の`×`など他の値として出力したい場合に指定します。

戻り値:

falseの値の代替として出力される値。

デフォルト:

"false"

ignoreCase

public abstract boolean ignoreCase

読み込み時に、大文字・小文字を区別なく候補の値と比較して判定するか指定します。

戻り値:

trueの場合、大文字・小文字の区別は行いません。

デフォルト:

false

failToFalse

public abstract boolean failToFalse

読み込み時に readForTrue()、readForFalse() で指定した候補の値と一致しない場合、値をfalseとして読み込み込むか指定します。

戻り値:

trueの場合、読み込み用の候補の値と一致しない場合、falseとして読み込みます。

デフォルト:

false

message

public abstract String message

エラー時のメッセージを指定します。

{key}の書式の場合、プロパティファイルから取得した値を指定できます。

このメッセージは、文字列をブール型にパースする際に失敗したときに適用されるメッセージに使用します。

戻り値:

省略した場合は、適用されたCellProcessorに基づいたメッセージが出力されます。

デフォルト:

"{com.github.mygreen.supercsv.annotation.format.CsvBooleanFormat.message}"