CsvDateTimeFormat (Super CSV Annotation 2.4 API)

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

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

アノテーションを付与しないときや属性pattern()を指定しないときは、クラスタイプごとに決まった標準の書式が適用されます。
対応しているクラスタイプと標準の書式は以下の通りです。

対応する日時のクラスタイプと標準の書式
クラスタイプ	標準の書式
java.util.Date	yyyy-MM-dd HH:mm:ss
java.util.Calendar	yyyy-MM-dd HH:mm:ss
java.sql.Date	yyyy-MM-dd
java.sql.Time	HH:mm:ss
java.sql.Timestamp	yyyy-MM-dd HH:mm:ss.SSS
java.time.LocalDateTime	uuuu-MM-dd HH:mm:ss
java.time.LocalDate	uuuu-MM-dd
java.time.LocalTime	HH:mm:ss
java.time.ZonedDateTime	uuuu-MM-dd HH:mm:ssxxx'['VV']'
java.time.OffsetDateTime	uuuu-MM-dd HH:mm:ssxxx
java.time.OffsetTime	HH:mm:ssxxx
java.time.Year	uuuu
java.time.YearMonth	uuuu-MM
java.time.MonthDay	MM-dd
org.joda.time.LocalDateTime	yyyy-MM-dd HH:mm:ss
org.joda.time.LocalDate	yyyy-MM-dd
org.joda.time.LocalTime	HH:mm:ss
org.joda.time.DateTime	yyyy-MM-dd HH:mm:ssZZ
org.joda.time.YearMonth	yyyy-MM
org.joda.time.MonthDay	MM-dd

基本的な使い方

属性pattern()で、書式を指定します。
省略した場合は、標準の書式が適用されます。
属性locale()でロケールを指定します。
- 言語コードのみを指定する場合、ja の2桁で指定します。
- 言語コードと国コードを指定する場合、ja_JP のようにアンダーバーで区切り指定します。
- 和暦を扱う時など、バリアントを指定する場合も同様に、ja_JP_JP のようにさらにアンダーバーで区切り指定します。


 @CsvBean
 public class SampleCsv {
     
     // 和暦を扱う場合
     @CsvColumn(number=1)
     @CsvDateTimeFormat(pattern="GGGGyy年MM月dd日", locale="ja_JP_JP")
     private Date japaneseDate;
     
     @CsvColumn(number=2, label="更新日時")
     @CsvDateTimeFormat(pattern="uuuu/MM/dd HH:mm:ss")
     private LocalDateTime updateTime;
     
     // getter/setterは省略
 }

バージョン:: 2.0
作成者:: T.TSUCHIE

任意要素のサマリー

任意要素
修飾子とタイプ	任意要素と説明
`boolean`	`lenient` 読み込み時に日時の解析を曖昧に行うか指定します。
`String`	`locale` ロケールを指定します。
`String`	`message` エラー時のメッセージを指定します。
`String`	`pattern` 日時の書式を指定します。
`String`	`timezone` タイムゾーンを指定します。

- 要素の詳細
  - pattern
```
public abstract String pattern
```
    日時の書式を指定します。
    クラスタイプごとに、指定可能な書式は異なります。
    
    java.util.Date/java.util.Calendar/java.sql.Date/java.sql.Time/java.sql.Timestampの場合、 SimpleDateFormatで解釈可能な書式を指定します。
    
    java.time.LocalDateTime/java.time.LocalDate/java.time.LocalTime/java.time.ZonedDateTime/java.time.OffsetDateTime/java.time.OffsetTime/java.time.Year/java.time,YearMonth/java.time/MonthDayの場合、 DateTimeFormatterで解釈可能な書式を指定します。
    
    org.joda.time.LocalDateTime/org.joda.time.LocalDate/org.joda.time.LocalTime/org.joda.time.YearMonth/org.joda.time.MonthDayの場合、 DateTimeFormatで解釈可能な書式を指定します。
    
    戻り値:
    
    指定しない場合は、クラスタイプごとの標準の書式が適用されます。
    
    デフォルト:
    
    ""
- - lenient
```
public abstract boolean lenient
```
    読み込み時に日時の解析を曖昧に行うか指定します。
    曖昧に解析する場合、例えば、2016-02-31 と存在しない日を解析すると、2016-03-02 と自動的に補正が行われます。
    
    戻り値:
    
    trueの場合、曖昧に解析を行います。
    
    デフォルト:
    
    false
- - timezone
```
public abstract String timezone
```
    タイムゾーンを指定します。
    TimeZone.getTimeZone(String)で解釈可能な値を指定する必要があります。
    
    Asia/Tokyo, GMT, GMT+09:00などの値を指定します。
    
    ただし、オフセットを持たないクラスタイプLocalDateTime, LocalDate, LocalTimeの時は、指定しても意味がありません。
    
    戻り値:
    
    省略した場合、システム標準の値を使用します。
    
    デフォルト:
    
    ""
- - locale
```
public abstract String locale
```
    ロケールを指定します。
    <言語コード>、<言語コード>_<国コード>、<言語コード>_<国コード>_<バリアント>の3つの何れかで書式を指定します。
    
    例 'ja'、'ja_JP'、'ja_JP_JP'
    
    戻り値:
    
    省略した場合、システム標準の値を使用します。
    
    デフォルト:
    
    ""
- - message
```
public abstract String message
```
    エラー時のメッセージを指定します。
    ${key}の書式の場合、プロパティファイルから取得した値を指定できます。
    
    このメッセージは、文字列を日時型にパースする際に失敗したときに適用されるメッセージに使用します。
    - lineNumber : カラムの値に改行が含まれている場合を考慮した実際の行番号です。1から始まります。
    - rowNumber : CSVの行番号です。1から始まります。
    - columnNumber : CSVの列番号です。1から始まります。
    - label : カラムの見出し名です。
    - validatedValue : 実際のカラムの値です。
    - pattern : アノテーションの属性pattern()の値です。指定されていない場合はデフォルトの値が設定されます。
    戻り値:
    
    省略した場合は、適用されたCellProcessorに基づいたメッセージが出力されます。
    
    デフォルト:
    
    "{com.github.mygreen.supercsv.annotation.format.CsvDateTimeFormat.message}"

注釈型 CsvDateTimeFormat

基本的な使い方

任意要素のサマリー

要素の詳細

pattern

lenient

timezone

locale

message