com.github.mygreen.supercsv.annotation.format

注釈型 CsvFormat

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

任意のタイプの書式を指定するためのアノテーションです。

このライブラリに対応していない書式や独自のタイプに対応する際に使用します。

基本的な使い方

• 属性formatter()で、TextFormatterの実装クラスを指定します。
• TextFormatterは、文字列とオブジェクトの相互に変換するためのインタフェースになります。
  通常は、抽象クラスAbstractTextFormatterを継承して作成します。

以下に、java.net.URLにマッピングする例を示します。

 @CsvBean
 public class SampleCsv {
     
     @CsvColumn(number=1, label="ホームページ")
     @CsvFormat(formatter=UrlFormatter.class)  // 実装したTextFormatterの指定
     private URL homepage;
     
     // getter/setterは省略
 }
 
 // TextFormatterの実装クラス - URLにマッピングするクラス
 public class UrlFormatter extends AbstractTextFormatter<URL> {
       
       // 読み込み時の文字列からオブジェクト型に変換するメソッドの実装
       @Override
       public URL parse(final String text) {
           
           try {
               return new URL(text);
           } catch(MalformedURLException e) {
               throw new TextParseException(text, URL.class, e);
           }
           
       }
       
       // 書き込みにオブジェクト型から文字列に変換するメソッドの実装
       @Override
       public String print(final URL object) {
           return object.toExternalForm();
       }
       
       // 読み込み時のエラーメッセージ中で使用可能な変数の定義
       // 必要があればオーバライドして実装します。
       @Override
       public Map<String, Object> getMessageVariables() {
       
           final Map<String, Object> vars = new HashMap<>();
           
           vars.put("key", "vars");
           
           return vars;
       }
       
   }
 

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
Class<? extends TextFormatter>	formatter フォーマッタのクラスを指定します。

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
String	message エラー時のメッセージを指定します。

要素の詳細

formatter

public abstract Class<? extends TextFormatter> formatter

フォーマッタのクラスを指定します。

戻り値:

TextFormatterの実装クラスを指定します。

message

public abstract String message

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

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

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

戻り値:

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

デフォルト:

""