DateTimeFormat (Spring Framework API)

```
@DocumentedSE
 @RetentionSE(valueSE=RUNTIMESE)
 @TargetSE(valueSE={METHODSE,FIELDSE,PARAMETERSE,ANNOTATION_TYPESE})
public @interface DateTimeFormat
```
フィールドまたはメソッドのパラメーターを日付または時刻としてフォーマットする必要があることを宣言します。
スタイルパターン、ISO 日時パターン、カスタムフォーマットパターン文字列によるフォーマットをサポートします。DateSE、CalendarSE、LongSE（ミリ秒のタイムスタンプ用）および JSR-310 java.time 値型に適用できます。
スタイルベースのフォーマットの場合は、style() 属性を目的のスタイルパターンコードに設定します。コードの最初の文字は日付スタイルで、2 番目の文字は時間スタイルです。ショートスタイルの場合は "S"、ミディアムスタイルの場合は "M"、ロングスタイルの場合は "L"、フルスタイルの場合は "F" の文字を指定します。スタイル文字 "-" を指定することにより、日付または時刻を省略できます。たとえば、"M-" は、時刻のない日付の中判形式を指定します。
ISO ベースのフォーマットの場合、iso() 属性を DateTimeFormat.ISO.DATE などの目的の DateTimeFormat.ISO フォーマットに設定します。
カスタムフォーマットの場合は、pattern() 属性を "yyyy/MM/dd hh:mm:ss a" などの日時パターンに設定します。
各属性は相互に排他的であるため、アノテーションインスタンスごとに 1 つの属性のみを設定します（フォーマットのニーズに最も便利な属性）。
- パターン属性を指定すると、スタイル属性と ISO 属性の両方よりも優先されます。
- iso() 属性を指定すると、style 属性よりも優先されます。
- アノテーション属性が指定されていない場合、適用されるデフォルトの形式は、スタイルコード "SS" （短い日付、短い時間）のスタイルベースです。
タイムゾーン
style() または pattern() 属性が使用される場合は常に、DateSE 値をフォーマットするときに JVM のデフォルトのタイムゾーンが使用SEされます。 DateSE 値をフォーマットするときに iso() 属性が使用される場合は常に、UTC がタイムゾーンとして使用されます。同じタイムゾーンがフォールバックパターンにも適用されます。タイムゾーンとして UTC を一貫して使用するために、-Duser.timezone=UTC を使用して JVM をブートストラップできます。
導入:
3.0
作成者:
Keith Donald, Juergen Hoeller, Sam Brannen
関連事項:
DateTimeFormatterSE, DateTimeFormat

オプション要素のサマリー

オプション要素
修飾子と型	オプションの要素と説明
`StringSE[]`	`fallbackPatterns` プライマリ `pattern()`、`iso()`、`style()` 属性の解析が失敗した場合のフォールバックとして使用するカスタムパターンのセット。
`DateTimeFormat.ISO`	`iso` フィールドまたはメソッドパラメーターのフォーマットに使用する ISO パターン。
`StringSE`	`pattern` フィールドまたはメソッドのパラメーターをフォーマットするために使用するカスタムパターン。
`StringSE`	`style` フィールドまたはメソッドパラメーターのフォーマットに使用するスタイルパターン。

- 要素の詳細
  - style
```
public abstract StringSE style
```
    フィールドまたはメソッドパラメーターのフォーマットに使用するスタイルパターン。
    短い日付、短い時間の場合、デフォルトは "SS" です。デフォルトのスタイル以外の一般的なスタイルに従ってフィールドまたはメソッドのパラメーターをフォーマットする場合は、この属性を設定します。
    関連事項:
    fallbackPatterns()
    デフォルト:
    "SS"
- - iso
```
public abstract DateTimeFormat.ISO iso
```
    フィールドまたはメソッドパラメーターのフォーマットに使用する ISO パターン。
    サポートされている ISO パターンは、DateTimeFormat.ISO 列挙型で定義されています。
    デフォルトは DateTimeFormat.ISO.NONE で、この属性を無視する必要があることを示します。ISO 形式に従ってフィールドまたはメソッドパラメーターをフォーマットする場合は、この属性を設定します。
    関連事項:
    fallbackPatterns()
    デフォルト:
    org.springframework.format.annotation.DateTimeFormat.ISO.NONE
- - pattern
```
public abstract StringSE pattern
```
    フィールドまたはメソッドのパラメーターをフォーマットするために使用するカスタムパターン。
    デフォルトは空の文字列で、カスタムパターンの文字列が指定されていないことを示します。スタイルまたは ISO 形式で表されていないカスタム日時パターンに従ってフィールドまたはメソッドのパラメーターをフォーマットする場合は、この属性を設定します。
    メモ: このパターンは、Joda-Time でもサポートされている元の SimpleDateFormatSE スタイルに従い、オーバーフローに対する厳密な解析セマンティクスを備えています（たとえば、うるう年以外の 2 月 29 日の値を拒否します）。結果として、"yy" 文字は、DateTimeFormatterSE 仕様のような「年」ではなく、従来のスタイルで年を示します（つまり、厳密な解決モードで DateTimeFormatter を実行すると、"yy" は "uu" に変わります）。
    関連事項:
    fallbackPatterns()
    デフォルト:
    ""
- - fallbackPatterns
```
public abstract StringSE[] fallbackPatterns
```
    プライマリ pattern()、iso()、style() 属性の解析が失敗した場合のフォールバックとして使用するカスタムパターンのセット。
    例: 解析と出力に ISO 日付形式を使用したいが、さまざまな日付形式のユーザー入力の寛大な解析を許可する場合は、次のように構成できます。
```
 @DateTimeFormat(iso = ISO.DATE, fallbackPatterns = { "M/d/yy", "dd.MM.yyyy" })
 
```
    フォールバックパターンは、解析にのみ使用されます。値を文字列として出力するためには使用されません。プライマリ pattern()、iso()、style() 属性は、常に出力に使用されます。フォールバックパターンに使用されるタイムゾーンの詳細については、クラスレベルのドキュメントを参照してください。
    フォールバックパターンは、Joda-Time 値型ではサポートされていません。
    導入:
    5.3.5
    デフォルト:
    {}

アノテーション型 DateTimeFormat

タイムゾーン

オプション要素のサマリー

要素の詳細

style

iso

pattern

fallbackPatterns