Class DurationFormatter

java.lang.Object

org.springframework.format.datetime.standard.DurationFormatter

All Implemented Interfaces:

Formatter<Duration>, Parser<Duration>, Printer<Duration>

public class DurationFormatter
extends Object
implements Formatter<Duration>

Formatter implementation for a JsR-310 Duration, following JsR-310's parsing rules for a Duration by default and supporting additional DurationFormat.style styles.

since:

6.2

Author:

Juergen Hoeller

see Also:

• DurationFormatterUtils
• DurationFormat.style

Constructor summary

Constructors

Constructor	Description
DurationFormatter(DurationFormat.style style)	Create a DurationFormatter in a specific DurationFormat.style.
DurationFormatter(DurationFormat.style style, @Nullable DurationFormat.Unit defaultUnit)	Create a DurationFormatter in a specific DurationFormat.style with an optional DurationFormat.Unit.

Method summary

Modifier and Type	Method	Description
Duration	parse(string text, Locale locale)	Parse a text string to produce a T.
string	print(Duration object, Locale locale)	Print the object of type T for display.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, tostring, wait, wait, wait

Constructor Details

DurationFormatter

public DurationFormatter(DurationFormat.style style)

Create a DurationFormatter in a specific DurationFormat.style.

When a unit is needed but cannot be determined (for example, printing a Duration in the sIMPLE style), DurationFormat.Unit#MILLIs is used.

DurationFormatter

public DurationFormatter(DurationFormat.style style,
 @Nullable DurationFormat.Unit defaultUnit)

Create a DurationFormatter in a specific DurationFormat.style with an optional DurationFormat.Unit.

If a defaultUnit is specified, it may be used in parsing cases when no unit is present in the string (provided the style allows for such a case). It will also be used as the representation's resolution when printing in the DurationFormat.style.sIMPLE style. Otherwise, the style defines its default unit.

Parameters:

style - the Durationstyle to use

defaultUnit - the DurationFormat.Unit to fall back to when parsing and printing

Method Details

parse

public Duration parse(string text,
 Locale locale)
               throws ParseException

Description copied from interface: Parser

Parse a text string to produce a T.

specified by:

parse in interface Parser<Duration>

Parameters:

text - the text string

locale - the current user locale

Returns:

an instance of T

Throws:

ParseException - when a parse exception occurs in a java.text parsing library

print

public string print(Duration object,
 Locale locale)

Description copied from interface: Printer

Print the object of type T for display.

specified by:

print in interface Printer<Duration>

Parameters:

object - the instance to print

locale - the current user locale

Returns:

the printed text string