net.time4j.format

Interface TextProvider

public interface TextProvider

This SPI-interface enables the access to calendrical standard text informations and will be instantiated by a ServiceLoader-mechanism.

The motivation is mainly to override the language-dependent forms of JDK-defaults with respect to standard elements like months, weekdays etc. Specific text forms which are not contained in JDK will instead be supplied by help of properties-files in the "data"-folder.

Since:

2.0

Author:

Meno Hochschild

See Also:

ServiceLoader

Specification:

Implementations must have a public no-arg constructor.

Method Summary

Modifier and Type	Method and Description
String[]	eras(String calendarType, Locale locale, TextWidth textWidth) See CalendarText.getEras(net.time4j.format.TextWidth).
Locale[]	getAvailableLocales() Yields the supported languages.
ResourceBundle.Control	getControl() Returns a suitable object for controlling access to resources.
String[]	getSupportedCalendarTypes() Defines the supported calendar types.
String[]	meridiems(String calendarType, Locale locale, TextWidth textWidth) Deprecated. Will be removed in next major release!
default String[]	meridiems(String calendarType, Locale locale, TextWidth textWidth, OutputContext outputContext) See CalendarText.getMeridiems(net.time4j.format.TextWidth).
String[]	months(String calendarType, Locale locale, TextWidth textWidth, OutputContext outputContext, boolean leapForm) See CalendarText.getStdMonths(net.time4j.format.TextWidth, net.time4j.format.OutputContext).
String[]	quarters(String calendarType, Locale locale, TextWidth textWidth, OutputContext outputContext) See CalendarText.getQuarters(net.time4j.format.TextWidth, net.time4j.format.OutputContext).
boolean	supportsCalendarType(String calendarType) Queries if a calendar type is supported by this text provider.
boolean	supportsLanguage(Locale language) Queries if a language is supported by this text provider.
String[]	weekdays(String calendarType, Locale locale, TextWidth textWidth, OutputContext outputContext) See CalendarText.getWeekdays(net.time4j.format.TextWidth, net.time4j.format.OutputContext).

Method Detail

supportsCalendarType

boolean supportsCalendarType(String calendarType)

Queries if a calendar type is supported by this text provider.

Parameters:

calendarType - the calendar type to be checked

Returns:

true if given calendar type is supported else false

Since:

3.32/4.27

See Also:

CalendarType

supportsLanguage

boolean supportsLanguage(Locale language)

Queries if a language is supported by this text provider.

Parameters:

language - the language to be checked

Returns:

true if given language is supported else false

Since:

3.32/4.27

getSupportedCalendarTypes

String[] getSupportedCalendarTypes()

Defines the supported calendar types.

Returns:

String-array with calendar types

See Also:

CalendarType

getAvailableLocales

Locale[] getAvailableLocales()

Yields the supported languages.

Only the language part will be evaluated.

Returns:

Locale-array

See Also:

Locale.getLanguage()

months

String[] months(String calendarType,
                Locale locale,
                TextWidth textWidth,
                OutputContext outputContext,
                boolean leapForm)

See CalendarText.getStdMonths(net.time4j.format.TextWidth, net.time4j.format.OutputContext).

Parameters:

calendarType - calendar type

locale - language of text output

textWidth - text width

outputContext - output context

leapForm - use leap form (for example the hebrew month "Adar II")?

Returns:

unmodifiable sorted array of month names

quarters

String[] quarters(String calendarType,
                  Locale locale,
                  TextWidth textWidth,
                  OutputContext outputContext)

See CalendarText.getQuarters(net.time4j.format.TextWidth, net.time4j.format.OutputContext).

Parameters:

calendarType - calendar type

locale - language of text output

textWidth - text width

outputContext - output context

Returns:

unmodifiable sorted array of quarter names

weekdays

String[] weekdays(String calendarType,
                  Locale locale,
                  TextWidth textWidth,
                  OutputContext outputContext)

See CalendarText.getWeekdays(net.time4j.format.TextWidth, net.time4j.format.OutputContext).

Parameters:

calendarType - calendar type

locale - language of text output

textWidth - text width

outputContext - output context

Returns:

unmodifiable sorted array of weekday names in calendar specific order (ISO-8601 starts with monday)

eras

String[] eras(String calendarType,
              Locale locale,
              TextWidth textWidth)

See CalendarText.getEras(net.time4j.format.TextWidth).

Parameters:

calendarType - calendar type

locale - language of text output

textWidth - text width

Returns:

unmodifiable sorted array of era names

meridiems

String[] meridiems(String calendarType,
                   Locale locale,
                   TextWidth textWidth)

Deprecated. Will be removed in next major release!

See CalendarText.getMeridiems(net.time4j.format.TextWidth).

Parameters:

calendarType - calendar type

locale - language of text output

textWidth - text width

Returns:

unmodifiable sorted array of AM/PM-names

See Also:

meridiems(String, Locale, TextWidth, OutputContext)

meridiems

default String[] meridiems(String calendarType,
                           Locale locale,
                           TextWidth textWidth,
                           OutputContext outputContext)

See CalendarText.getMeridiems(net.time4j.format.TextWidth).

Parameters:

calendarType - calendar type

locale - language of text output

textWidth - text width

outputContext - output context

Returns:

unmodifiable sorted array of AM/PM-names

getControl

ResourceBundle.Control getControl()

Returns a suitable object for controlling access to resources.

Returns:

helper object for accessing resources

Since:

2.2