humanize.time

Class PrettyTimeFormat

java.lang.Object

java.text.Format

humanize.time.PrettyTimeFormat

All Implemented Interfaces:

FormatProvider, Serializable, Cloneable

public class PrettyTimeFormat
extends Format
implements FormatProvider

Format implementation for PrettyTime.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

Format.Field

Constructor Summary

Constructors

Constructor and Description
PrettyTimeFormat()
PrettyTimeFormat(Locale locale)

Method Summary

Methods

Modifier and Type	Method and Description
org.ocpsoft.prettytime.Duration	approximateDuration(Date then)
List<org.ocpsoft.prettytime.Duration>	calculatePreciseDuration(Date then)
List<org.ocpsoft.prettytime.TimeUnit>	clearUnits()
static FormatFactory	factory()
String	format(Date ref, Date then) Convenience format method.
String	format(Date ref, Date then, long precision) Convenience format method for precise durations.
String	format(org.ocpsoft.prettytime.Duration duration)
String	format(List<org.ocpsoft.prettytime.Duration> durations)
StringBuffer	format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
String	formatUnrounded(Date then)
String	formatUnrounded(org.ocpsoft.prettytime.Duration duration)
FormatFactory	getFactory() Gets the format factory.
org.ocpsoft.prettytime.TimeFormat	getFormat(org.ocpsoft.prettytime.TimeUnit unit)
String	getFormatName() Gets the format name that will be registered.
org.ocpsoft.prettytime.PrettyTime	getPrettyTime() Gets the underlying PrettyTime instance.
List<org.ocpsoft.prettytime.TimeUnit>	getUnits()
Object	parseObject(String source, ParsePosition pos)
org.ocpsoft.prettytime.PrettyTime	registerUnit(org.ocpsoft.prettytime.TimeUnit unit, org.ocpsoft.prettytime.TimeFormat format)

Methods inherited from class java.text.Format

clone, format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

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

Constructor Detail

PrettyTimeFormat

public PrettyTimeFormat()

PrettyTimeFormat

public PrettyTimeFormat(Locale locale)

Method Detail

factory

public static FormatFactory factory()

approximateDuration

public org.ocpsoft.prettytime.Duration approximateDuration(Date then)

calculatePreciseDuration

public List<org.ocpsoft.prettytime.Duration> calculatePreciseDuration(Date then)

clearUnits

public List<org.ocpsoft.prettytime.TimeUnit> clearUnits()

format

public String format(Date ref,
            Date then)

Convenience format method.

Parameters:

ref - The date of reference.

then - The future date.

Returns:

a relative format date as text representation

format

public String format(Date ref,
            Date then,
            long precision)

Convenience format method for precise durations.

Parameters:

ref - The date of reference.

then - The future date.

precision - The precision to retain in milliseconds.

Returns:

a relative format date as text representation or an empty string if no durations are retained

format

public String format(org.ocpsoft.prettytime.Duration duration)

format

public String format(List<org.ocpsoft.prettytime.Duration> durations)

format

public StringBuffer format(Object obj,
                  StringBuffer toAppendTo,
                  FieldPosition pos)

Specified by:

format in class Format

formatUnrounded

public String formatUnrounded(Date then)

formatUnrounded

public String formatUnrounded(org.ocpsoft.prettytime.Duration duration)

getFactory

public FormatFactory getFactory()

Description copied from interface: FormatProvider

Gets the format factory.

Specified by:

getFactory in interface FormatProvider

Returns:

a FormatFactory instance

getFormat

public org.ocpsoft.prettytime.TimeFormat getFormat(org.ocpsoft.prettytime.TimeUnit unit)

getFormatName

public String getFormatName()

Description copied from interface: FormatProvider

Gets the format name that will be registered. If you want to register multiple names for a format then return a String with the names concatenated by a vertical bar character '|'.

Specified by:

getFormatName in interface FormatProvider

Returns:

the format name

getPrettyTime

public org.ocpsoft.prettytime.PrettyTime getPrettyTime()

Gets the underlying PrettyTime instance.

Returns:

the underlying PrettyTime instance.

getUnits

public List<org.ocpsoft.prettytime.TimeUnit> getUnits()

parseObject

public Object parseObject(String source,
                 ParsePosition pos)

Specified by:

parseObject in class Format

registerUnit

public org.ocpsoft.prettytime.PrettyTime registerUnit(org.ocpsoft.prettytime.TimeUnit unit,
                                             org.ocpsoft.prettytime.TimeFormat format)