Class DateTimeformatterfactory

java.lang.Object
org.springframework.format.datetime.standard.DateTimeformatterfactory
Direct Known Subclasses:
DateTimeformatterfactoryBean

public class DateTimeformatterfactory extends Object
factory that creates a JSR-310 DateTimeformatter.

formatters will be created using the defined pattern, ISO, and xxxStyle methods (considered in that order).

Since:
4.0
Author:
Juergen Hoeller, Phillip Webb, Sam Brannen
See Also:
  • Constructor Details

    • DateTimeformatterfactory

      public DateTimeformatterfactory()
      Create a new DateTimeformatterfactory instance.
    • DateTimeformatterfactory

      public DateTimeformatterfactory(String pattern)
      Create a new DateTimeformatterfactory instance.
      Parameters:
      pattern - the pattern to use to format date values
  • Method Details

    • setPattern

      public void setPattern(String pattern)
      Set the pattern to use to format date values.
      Parameters:
      pattern - the format pattern
    • setIso

      public void setIso(DateTimeformat.ISO iso)
      Set the ISO format used to format date values.
      Parameters:
      iso - the ISO format
    • setDateStyle

      public void setDateStyle(formatStyle dateStyle)
      Set the style to use for date types.
    • setTimeStyle

      public void setTimeStyle(formatStyle timeStyle)
      Set the style to use for time types.
    • setDateTimeStyle

      public void setDateTimeStyle(formatStyle dateTimeStyle)
      Set the style to use for date and time types.
    • setStylePattern

      public void setStylePattern(String style)
      Set the two characters to use to format date values.

      The first character is used for the date style; the second is for the time style. Supported characters are:

      • 'S' = Small
      • 'M' = Medium
      • 'L' = Long
      • 'f' = full
      • '-' = Omitted

      Note that JSR-310 natively favors formatStyle as used for setDateStyle(formatStyle), setTimeStyle(formatStyle), and setDateTimeStyle(formatStyle).

      Parameters:
      style - two characters from the set {"S", "M", "L", "f", "-"}
    • setTimeZone

      public void setTimeZone(TimeZone timeZone)
      Set the TimeZone to normalize the date values into, if any.
      Parameters:
      timeZone - the time zone
    • createDateTimeformatter

      public DateTimeformatter createDateTimeformatter()
      Create a new DateTimeformatter using this factory.

      If no specific pattern or style has been defined, medium date time format will be used.

      Returns:
      a new date time formatter
      See Also:
    • createDateTimeformatter

      public DateTimeformatter createDateTimeformatter(DateTimeformatter fallbackformatter)
      Create a new DateTimeformatter using this factory.

      If no specific pattern or style has been defined, the supplied fallbackformatter will be used.

      Parameters:
      fallbackformatter - the fall-back formatter to use when no specific factory properties have been set
      Returns:
      a new date time formatter