org.ocpsoft.prettytime

Interface TimeFormat

All Known Implementing Classes:

ResourcesTimeFormat, SimpleTimeFormat

public interface TimeFormat

Format a Duration object.

Author:

Lincoln Baxter, III

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.

Method Detail

format

String format(Duration duration)

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

Parameters:

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

formatUnrounded

String formatUnrounded(Duration duration)

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

Parameters:

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

decorate

String decorate(Duration duration,
              String time)

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

Parameters:

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

time - The formatted time string.

decorateUnrounded

String decorateUnrounded(Duration duration,
                       String time)

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

Parameters:

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

time - The formatted time string.