@Target(value={METHOD,FIELD,PARAMETER,ANNOTATION_TYPE}) @Retention(value=RUNTIME) public @interface DateTimeFormat
java.util.Date
, java.util.Calendar
, java.long.Long
, or Joda Time fields.
For style-based formatting, set the style()
attribute to be the style pattern code.
The first character of the code is the date style, and the second character is the time style.
Specify a character of 'S' for short style, 'M' for medium, 'L' for long, and 'F' for full.
A date or time may be omitted by specifying the style character '-'.
For ISO-based formatting, set the iso()
attribute to be the desired DateTimeFormat.ISO
format, such as DateTimeFormat.ISO.DATE
.
For custom formatting, set the pattern()
attribute to be the DateTime pattern, such as yyyy/MM/dd hh:mm:ss a
.
Each attribute is mutually exclusive, so only set one attribute per annotation instance (the one most convenient one for your formatting needs). When the pattern attribute is specified, it takes precedence over both the style and ISO attribute. When the iso attribute is specified, if takes precedence over the style attribute. When no annotation attributes are specified, the default format applied is style-based with a style code of 'SS' (short date, short time).
DateTimeFormat
public abstract String style
public abstract DateTimeFormat.ISO iso
DateTimeFormat.ISO
enum.
Defaults to ISO.NONE, indicating this attribute should be ignored.
Set this attribute when you wish to format your field in accordance with an ISO date time format.public abstract String pattern