org.joda.time.format

Class PeriodFormat

java.lang.Object

org.joda.time.format.PeriodFormat

public class PeriodFormat
extends java.lang.Object

Factory that creates instances of PeriodFormatter.

Period formatting is performed by the PeriodFormatter class. Three classes provide factory methods to create formatters, and this is one. The others are ISOPeriodFormat and PeriodFormatterBuilder.

PeriodFormat is thread-safe and immutable, and the formatters it returns are as well.

Since:

1.0

Author:

Brian S O'Neill

See Also:

ISOPeriodFormat, PeriodFormatterBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PeriodFormat() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static PeriodFormatter	getDefault() Gets the default PeriodFormatter.

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodFormat

protected PeriodFormat()

Constructor.

Since:

1.1 (previously private)

Method Detail

getDefault

public static PeriodFormatter getDefault()

Gets the default PeriodFormatter.

This currently returns a word based formatter using English only. Hopefully future release will support localized period formatting.

Returns:

the formatter