org.ocpsoft.prettytime.impl

Class ResourcesTimeFormat

java.lang.Object

org.ocpsoft.prettytime.format.SimpleTimeFormat

org.ocpsoft.prettytime.impl.ResourcesTimeFormat

All Implemented Interfaces:

LocaleAware<ResourcesTimeFormat>, TimeFormat

public class ResourcesTimeFormat
extends SimpleTimeFormat
implements TimeFormat, LocaleAware<ResourcesTimeFormat>

Represents a simple method of formatting a specific Duration of time

Author:

lb3

Field Summary

Fields inherited from class org.ocpsoft.prettytime.format.SimpleTimeFormat

QUANTITY, SIGN, UNIT

Constructor Summary

Constructors

Constructor and Description
ResourcesTimeFormat(ResourcesTimeUnit unit)

Method Summary

Methods

Modifier and Type	Method and Description
String	decorate(Duration duration, String time) Decorate with past or future prefix/suffix (with rounding)
String	decorateUnrounded(Duration duration, String time) Decorate with past or future prefix/suffix (without rounding)
String	format(Duration duration) Given a populated Duration object.
String	formatUnrounded(Duration duration) Given a populated Duration object.
ResourcesTimeFormat	setLocale(Locale locale) Set the Locale for which this instance should behave in.

Methods inherited from class org.ocpsoft.prettytime.format.SimpleTimeFormat

getGramaticallyCorrectName, getPattern, getPattern, getQuantity, setFuturePluralName, setFuturePrefix, setFutureSingularName, setFutureSuffix, setPastPluralName, setPastPrefix, setPastSingularName, setPastSuffix, setPattern, setPluralName, setRoundingTolerance, setSingularName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourcesTimeFormat

public ResourcesTimeFormat(ResourcesTimeUnit unit)

Method Detail

setLocale

public ResourcesTimeFormat setLocale(Locale locale)

Description copied from interface: LocaleAware

Set the Locale for which this instance should behave in.

Specified by:

setLocale in interface LocaleAware<ResourcesTimeFormat>

decorate

public String decorate(Duration duration,
              String time)

Description copied from interface: TimeFormat

Decorate with past or future prefix/suffix (with rounding)

Specified by:

decorate in interface TimeFormat

Overrides:

decorate in class SimpleTimeFormat

Parameters:

duration - The original Duration instance from which the time string should be decorated.

time - The formatted time string.

decorateUnrounded

public String decorateUnrounded(Duration duration,
                       String time)

Description copied from interface: TimeFormat

Decorate with past or future prefix/suffix (without rounding)

Specified by:

decorateUnrounded in interface TimeFormat

Overrides:

decorateUnrounded in class SimpleTimeFormat

Parameters:

duration - The original Duration instance from which the time string should be decorated.

time - The formatted time string.

format

public String format(Duration duration)

Description copied from interface: TimeFormat

Given a populated Duration object. Apply formatting (with rounding) and output the result.

Specified by:

format in interface TimeFormat

Overrides:

format in class SimpleTimeFormat

formatUnrounded

public String formatUnrounded(Duration duration)

Description copied from interface: TimeFormat

Given a populated Duration object. Apply formatting (without rounding) and output the result.

Specified by:

formatUnrounded in interface TimeFormat

Overrides:

formatUnrounded in class SimpleTimeFormat