public abstract @interface

DateTimeFormat

implements Annotation
org.springframework.format.annotation.DateTimeFormat

Class Overview

Declares that a field should be formatted as a date time. Supports formatting by style pattern, ISO date time pattern, or custom format pattern string. Can be applied to 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 DATE.

For custom formatting, set the #pattern() attribute to be the DateTime pattern, such as yyyy/mm/dd h: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).

See Also
  • org.joda.time.format.DateTimeFormat

Summary

Nested Classes
enum DateTimeFormat.ISO Common ISO date time format patterns. 
[Expand]
Inherited Methods
From interface java.lang.annotation.Annotation