Class DateFormatter
- java.lang.Object
- org.springframework.format.datetime.DateFormatter
public class DateFormatter extends Object implements Formatter<Date>
A formatter forDate
types. Allows the configuration of an explicit date pattern and locale.- Since:
- 3.0
- Author:
- Keith Donald, Juergen Hoeller, Phillip Webb
- See Also:
SimpleDateFormat
Constructor Summary
Constructors Constructor Description DateFormatter()
Create a new default DateFormatter.DateFormatter(String pattern)
Create a new DateFormatter for the given date pattern.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected DateFormat
getDateFormat(Locale locale)
Date
parse(String text, Locale locale)
Parse a text String to produce a T.String
print(Date date, Locale locale)
Print the object of type T for display.void
setIso(DateTimeFormat.ISO iso)
Set the ISO format used for this date.void
setLenient(boolean lenient)
Specify whether or not parsing is to be lenient.void
setPattern(String pattern)
Set the pattern to use to format date values.void
setStyle(int style)
Set the style to use to format date values.void
setStylePattern(String stylePattern)
Set the two character to use to format date values.void
setTimeZone(TimeZone timeZone)
Set the TimeZone to normalize the date values into, if any.
Constructor Detail
DateFormatter
public DateFormatter()
Create a new default DateFormatter.
DateFormatter
public DateFormatter(String pattern)
Create a new DateFormatter for the given date pattern.
Method Detail
setPattern
public void setPattern(String pattern)
Set the pattern to use to format date values.If not specified, DateFormat's default style will be used.
setIso
public void setIso(DateTimeFormat.ISO iso)
Set the ISO format used for this date.- Parameters:
iso
- theDateTimeFormat.ISO
format- Since:
- 3.2
setStyle
public void setStyle(int style)
Set the style to use to format date values.If not specified, DateFormat's default style will be used.
setStylePattern
public void setStylePattern(String stylePattern)
Set the two character to use to format date values. The first character used for the date style, the second is for the time style. Supported characters are- 'S' = Small
- 'M' = Medium
- 'L' = Long
- 'F' = Full
- '-' = Omitted
- This method mimics the styles supported by Joda-Time.
- Parameters:
stylePattern
- two characters from the set {"S", "M", "L", "F", "-"}- Since:
- 3.2
setTimeZone
public void setTimeZone(TimeZone timeZone)
Set the TimeZone to normalize the date values into, if any.
setLenient
public void setLenient(boolean lenient)
Specify whether or not parsing is to be lenient. Default is false.With lenient parsing, the parser may allow inputs that do not precisely match the format. With strict parsing, inputs must match the format exactly.
print
public String print(Date date, Locale locale)
Description copied from interface:Printer
Print the object of type T for display.
parse
public Date parse(String text, Locale locale) throws ParseException
Description copied from interface:Parser
Parse a text String to produce a T.- Specified by:
parse
in interfaceParser<Date>
- Parameters:
text
- the text stringlocale
- the current user locale- Returns:
- an instance of T
- Throws:
ParseException
- when a parse exception occurs in a java.text parsing library
getDateFormat
protected DateFormat getDateFormat(Locale locale)