net.time4j.format

Interface RelativeTimeProvider

All Superinterfaces:

UnitPatternProvider

public interface RelativeTimeProvider
extends UnitPatternProvider

This SPI-interface enables the access to localized unit patterns and is instantiated via a ServiceLoader-mechanism.

If there is no external RelativeTimeProvider then Time4J will use an internal implementation which just offers unit patterns either in english or in scientific notation.

Note: This interface enhances the standard UnitPatternProvider by new methods for short/abbreviated relative times and extra words for "yesterday-today-tomorrow".

Since:

3.6/4.4

Author:

Meno Hochschild

See Also:

ServiceLoader

Specification:

Implementations must have a public no-arg constructor.

Method Summary

Modifier and Type	Method and Description
String	getShortDayPattern(Locale lang, boolean future, PluralCategory category) Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of days in the past or future.
String	getShortHourPattern(Locale lang, boolean future, PluralCategory category) Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of hours in the past or future.
String	getShortMinutePattern(Locale lang, boolean future, PluralCategory category) Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of minutes in the past or future.
String	getShortMonthPattern(Locale lang, boolean future, PluralCategory category) Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of months in the past or future.
String	getShortSecondPattern(Locale lang, boolean future, PluralCategory category) Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of seconds in the past or future.
String	getShortWeekPattern(Locale lang, boolean future, PluralCategory category) Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of weeks in the past or future.
String	getShortYearPattern(Locale lang, boolean future, PluralCategory category) Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of years in the past or future.
String	getTodayWord(Locale lang) Yields the localized word for "today".
String	getTomorrowWord(Locale lang) Yields the localized word for "tomorrow".
String	getYesterdayWord(Locale lang) Yields the localized word for "yesterday".

Methods inherited from interface net.time4j.format.UnitPatternProvider

getDayPattern, getDayPattern, getHourPattern, getHourPattern, getListPattern, getMicroPattern, getMilliPattern, getMinutePattern, getMinutePattern, getMonthPattern, getMonthPattern, getNanoPattern, getNowWord, getSecondPattern, getSecondPattern, getWeekPattern, getWeekPattern, getYearPattern, getYearPattern

Method Detail

getShortYearPattern

String getShortYearPattern(Locale lang,
                           boolean future,
                           PluralCategory category)

Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of years in the past or future.

Parameters:

lang - language setting

future - use future or past form

category - plural category

Returns:

unit pattern for short years in the past or future

Throws:

MissingResourceException - if no pattern was found

Since:

3.6/4.4

getShortMonthPattern

String getShortMonthPattern(Locale lang,
                            boolean future,
                            PluralCategory category)

Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of months in the past or future.

Parameters:

lang - language setting

future - use future or past form

category - plural category

Returns:

unit pattern for short months in the past or future

Throws:

MissingResourceException - if no pattern was found

Since:

3.6/4.4

getShortWeekPattern

String getShortWeekPattern(Locale lang,
                           boolean future,
                           PluralCategory category)

Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of weeks in the past or future.

Parameters:

lang - language setting

future - use future or past form

category - plural category

Returns:

unit pattern for short weeks in the past or future

Throws:

MissingResourceException - if no pattern was found

Since:

3.6/4.4

getShortDayPattern

String getShortDayPattern(Locale lang,
                          boolean future,
                          PluralCategory category)

Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of days in the past or future.

Parameters:

lang - language setting

future - use future or past form

category - plural category

Returns:

unit pattern for short days in the past or future

Throws:

MissingResourceException - if no pattern was found

Since:

3.6/4.4

getShortHourPattern

String getShortHourPattern(Locale lang,
                           boolean future,
                           PluralCategory category)

Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of hours in the past or future.

Parameters:

lang - language setting

future - use future or past form

category - plural category

Returns:

unit pattern for short hours in the past or future

Throws:

MissingResourceException - if no pattern was found

Since:

3.6/4.4

getShortMinutePattern

String getShortMinutePattern(Locale lang,
                             boolean future,
                             PluralCategory category)

Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of minutes in the past or future.

Parameters:

lang - language setting

future - use future or past form

category - plural category

Returns:

unit pattern for short minutes in the past or future

Throws:

MissingResourceException - if no pattern was found

Since:

3.6/4.4

getShortSecondPattern

String getShortSecondPattern(Locale lang,
                             boolean future,
                             PluralCategory category)

Yields the localized unit pattern with short unit name and a placeholder "{0}" for the count of seconds in the past or future.

Parameters:

lang - language setting

future - use future or past form

category - plural category

Returns:

unit pattern for short seconds in the past or future

Throws:

MissingResourceException - if no pattern was found

Since:

3.6/4.4

getYesterdayWord

String getYesterdayWord(Locale lang)

Yields the localized word for "yesterday".

Parameters:

lang - language setting

Returns:

String

Throws:

MissingResourceException - if not found

Since:

3.6/4.4

getTodayWord

String getTodayWord(Locale lang)

Yields the localized word for "today".

Parameters:

lang - language setting

Returns:

String

Throws:

MissingResourceException - if not found

Since:

3.6/4.4

getTomorrowWord

String getTomorrowWord(Locale lang)

Yields the localized word for "tomorrow".

Parameters:

lang - language setting

Returns:

String

Throws:

MissingResourceException - if not found

Since:

3.6/4.4