アノテーションインターフェース NumberFormat
@DocumentedSE
@RetentionSE(RUNTIMESE)
@TargetSE({METHODSE,FIELDSE,PARAMETERSE,ANNOTATION_TYPESE})
public @interface NumberFormat
フィールドまたはメソッドのパラメーターを数値としてフォーマットする必要があることを宣言します。
スタイルまたはカスタムパターン文字列による書式設定をサポートします。Double や Long などの JDK Number 型に適用できます。
スタイルベースの書式設定の場合は、style() 属性を希望する NumberFormat.Style に設定します。カスタム書式設定の場合は、pattern() 属性を希望する数値パターン(例: "#,###.##")に設定します。
各属性は相互に排他的であるため、アノテーションごとに 1 つの属性のみ(フォーマットのニーズに最も適した属性)を設定してください。pattern() 属性が指定されている場合、style() 属性よりも優先されます。アノテーション属性が指定されていない場合、デフォルトのフォーマットは、アノテーション対象のフィールドまたはメソッドパラメーターの型に応じて、数値または通貨のスタイルベースです。
- 導入:
- 3.0
- 作成者:
- Keith Donald, Juergen Hoeller
- 関連事項:
ネストされたクラスの要約
ネストされたクラスオプション要素の概要
オプション要素修飾子と型オプションの要素説明フィールドまたはメソッドのパラメーターをフォーマットするために使用するカスタムパターン。フィールドまたはメソッドパラメーターのフォーマットに使用するスタイルパターン。
要素の詳細
style
NumberFormat.Style styleフィールドまたはメソッドパラメーターのフォーマットに使用するスタイルパターン。ほとんどのアノテーション付き型の汎用数値書式では、デフォルトで
NumberFormat.Style.DEFAULTに設定されます (通貨書式がデフォルトとなる money 型を除く)。フィールドまたはメソッドパラメーターをデフォルトのスタイル以外の共通スタイルに従ってフォーマットする場合は、この属性を設定します。
- デフォルト:
DEFAULT
pattern
StringSE patternフィールドまたはメソッドのパラメーターをフォーマットするために使用するカスタムパターン。デフォルトでは空の文字列になり、カスタムパターンが指定されていないことを示します。
スタイルで表されないカスタム数値パターンに従ってフィールドまたはメソッドパラメーターをフォーマットする場合は、この属性を設定します。
- デフォルト:
""