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.

Specification: Implementations must have a public no-arg constructor.

Since:

2.0

See Also:

ServiceLoader

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	eras(java.lang.String calendarType, java.util.Locale locale, TextWidth textWidth) See CalendarText.getEras(net.time4j.format.TextWidth).
java.util.Locale[]	getAvailableLocales() Yields the supported languages.
java.util.ResourceBundle.Control	getControl() Returns a suitable object for controlling access to resources.
java.lang.String[]	getSupportedCalendarTypes() Defines the supported calendar types.
java.lang.String[]	meridiems(java.lang.String calendarType, java.util.Locale locale, TextWidth textWidth) See CalendarText.getMeridiems(net.time4j.format.TextWidth).
java.lang.String[]	months(java.lang.String calendarType, java.util.Locale locale, TextWidth textWidth, OutputContext outputContext, boolean leapForm) See CalendarText.getStdMonths(net.time4j.format.TextWidth, net.time4j.format.OutputContext).
java.lang.String[]	quarters(java.lang.String calendarType, java.util.Locale locale, TextWidth textWidth, OutputContext outputContext) See CalendarText.getQuarters(net.time4j.format.TextWidth, net.time4j.format.OutputContext).
java.lang.String[]	weekdays(java.lang.String calendarType, java.util.Locale locale, TextWidth textWidth, OutputContext outputContext) See CalendarText.getWeekdays(net.time4j.format.TextWidth, net.time4j.format.OutputContext).

Method Detail

getSupportedCalendarTypes

java.lang.String[] getSupportedCalendarTypes()

Defines the supported calendar types.

Returns:

String-array with calendar types

See Also:

CalendarType

getAvailableLocales

java.util.Locale[] getAvailableLocales()

Yields the supported languages.

Returns:

Locale-array

months

java.lang.String[] months(java.lang.String calendarType,
                          java.util.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

java.lang.String[] quarters(java.lang.String calendarType,
                            java.util.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

java.lang.String[] weekdays(java.lang.String calendarType,
                            java.util.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

java.lang.String[] eras(java.lang.String calendarType,
                        java.util.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

java.lang.String[] meridiems(java.lang.String calendarType,
                             java.util.Locale locale,
                             TextWidth textWidth)

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

getControl

java.util.ResourceBundle.Control getControl()

Returns a suitable object for controlling access to resources.

Returns:

helper object for accessing resources

Since:

2.2