org.daisy.dotify.api.text

Interface Integer2TextFactoryMakerService

All Known Implementing Classes:

Integer2TextFactoryMaker

public interface Integer2TextFactoryMakerService

Provides an interface for a Integer2TextFactoryMaker service. The purpose of this interface is to expose an implementation of a Integer2TextFactoryMaker as an OSGi service.

To comply with this interface, an implementation must be thread safe and address both the possibility that only a single instance is created and used throughout and that new instances are created as desired.

Method Summary

Modifier and Type	Method and Description
Integer2TextFactory	getFactory(String locale) Gets a Integer2TextFactory that supports the specified locale
Collection<String>	listLocales() Returns a list of supported locales as defined by IETF RFC 3066.
Integer2Text	newInteger2Text(String locale) Creates a new integer2text.

Method Detail

getFactory

Integer2TextFactory getFactory(String locale)
                        throws Integer2TextConfigurationException

Gets a Integer2TextFactory that supports the specified locale

Parameters:

locale - the target locale

Returns:

returns a integer2text factory for the specified locale

Throws:

Integer2TextConfigurationException - if the locale is not supported

newInteger2Text

Integer2Text newInteger2Text(String locale)
                      throws Integer2TextConfigurationException

Creates a new integer2text. This is a convenience method for getFactory(target).newInteger2Text(target). Using this method excludes the possibility of setting features of the integer2text factory.

Parameters:

locale - the target locale

Returns:

returns a new integer2text

Throws:

Integer2TextConfigurationException - if the locale is not supported

listLocales

Collection<String> listLocales()

Returns a list of supported locales as defined by IETF RFC 3066.

Returns:

returns a list of locales