Package org.ocpsoft.prettytime.format

Class SimpleTimeFormat

java.lang.Object

org.ocpsoft.prettytime.format.SimpleTimeFormat

All Implemented Interfaces:

LocaleAware<SimpleTimeFormat>, TimeFormat

Direct Known Subclasses:

ResourcesTimeFormat

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

Represents a simple method of formatting a specific Duration of time

Author:

Lincoln Baxter, III

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QUANTITY
static final String	SIGN
static final String	UNIT

Constructor Summary

Constructors

Constructor	Description
SimpleTimeFormat()

Method Summary

Modifier and Type	Method	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.
protected String	getGramaticallyCorrectName(Duration d, boolean round)
String	getPattern()
protected String	getPattern(long quantity)
protected long	getQuantity(Duration duration, boolean round)
protected boolean	isPlural(Duration d, boolean round)
SimpleTimeFormat	setFuturePluralName(String futurePluralName)
SimpleTimeFormat	setFuturePrefix(String futurePrefix)
SimpleTimeFormat	setFutureSingularName(String futureSingularName)
SimpleTimeFormat	setFutureSuffix(String futureSuffix)
SimpleTimeFormat	setLocale(Locale locale)	Set the Locale for which this instance should behave in.
SimpleTimeFormat	setPastPluralName(String pastPluralName)
SimpleTimeFormat	setPastPrefix(String pastPrefix)
SimpleTimeFormat	setPastSingularName(String pastSingularName)
SimpleTimeFormat	setPastSuffix(String pastSuffix)
SimpleTimeFormat	setPattern(String pattern)
SimpleTimeFormat	setPluralName(String pluralName)
SimpleTimeFormat	setRoundingTolerance(int roundingTolerance)	The percentage of the current TimeUnit.getMillisPerUnit() for which the quantity may be rounded up by one.
SimpleTimeFormat	setSingularName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SIGN

public static final String SIGN

See Also:

• Constant Field Values

QUANTITY

public static final String QUANTITY

See Also:

• Constant Field Values

UNIT

public static final String UNIT

See Also:

• Constant Field Values

Constructor Details

SimpleTimeFormat

public SimpleTimeFormat()

Method Details

setLocale

public SimpleTimeFormat setLocale(Locale locale)

Description copied from interface: LocaleAware

Set the Locale for which this instance should behave in.

Specified by:

setLocale in interface LocaleAware<SimpleTimeFormat>

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

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

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

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

Parameters:

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

time - The formatted time string.

getPattern

protected String getPattern(long quantity)

getPattern

public String getPattern()

getQuantity

protected long getQuantity(Duration duration,
 boolean round)

getGramaticallyCorrectName

protected String getGramaticallyCorrectName(Duration d,
 boolean round)

isPlural

protected boolean isPlural(Duration d,
 boolean round)

setPattern

public SimpleTimeFormat setPattern(String pattern)

setFuturePrefix

public SimpleTimeFormat setFuturePrefix(String futurePrefix)

setFutureSuffix

public SimpleTimeFormat setFutureSuffix(String futureSuffix)

setPastPrefix

public SimpleTimeFormat setPastPrefix(String pastPrefix)

setPastSuffix

public SimpleTimeFormat setPastSuffix(String pastSuffix)

setRoundingTolerance

public SimpleTimeFormat setRoundingTolerance(int roundingTolerance)

The percentage of the current TimeUnit.getMillisPerUnit() for which the quantity may be rounded up by one.

setSingularName

public SimpleTimeFormat setSingularName(String name)

setPluralName

public SimpleTimeFormat setPluralName(String pluralName)

setFutureSingularName

public SimpleTimeFormat setFutureSingularName(String futureSingularName)

setFuturePluralName

public SimpleTimeFormat setFuturePluralName(String futurePluralName)

setPastSingularName

public SimpleTimeFormat setPastSingularName(String pastSingularName)

setPastPluralName

public SimpleTimeFormat setPastPluralName(String pastPluralName)

toString

public String toString()

Overrides:

toString in class Object