Interface BrailleTranslatorFactoryService
-
- All Known Implementing Classes:
DefaultBypassTranslatorFactoryService
,LiblouisBrailleTranslatorFactoryService
,SwedishBrailleTranslatorFactoryService
public interface BrailleTranslatorFactoryService
Provides an interface for a BrailleTranslatorFactory service. The purpose of this interface is to expose an implementation of a BrailleTranslatorFactory as a 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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Collection<TranslatorSpecification>
listSpecifications()
Returns a list of supported specifications.BrailleTranslatorFactory
newFactory()
Creates a new braille translator factory.default void
setCreatedWithSPI()
Informs the implementation that it was discovered and instantiated using information collected from a file within theMETA-INF/services
directory.boolean
supportsSpecification(String locale, String mode)
Returns true if the translator factory supports the given specification.
-
-
-
Method Detail
-
supportsSpecification
boolean supportsSpecification(String locale, String mode)
Returns true if the translator factory supports the given specification.- Parameters:
locale
- the translator localemode
- the translator grade, or null for uncontracted braille- Returns:
- returns true if the translator factory supports the specification
-
listSpecifications
Collection<TranslatorSpecification> listSpecifications()
Returns a list of supported specifications.- Returns:
- returns a list of specifications
-
newFactory
BrailleTranslatorFactory newFactory()
Creates a new braille translator factory.- Returns:
- returns a new braille translator factory
-
setCreatedWithSPI
default void setCreatedWithSPI()
Informs the implementation that it was discovered and instantiated using information collected from a file within the
META-INF/services
directory. In other words, it was created using SPI (service provider interfaces).This information, in turn, enables the implementation to use the same mechanism to set dependencies as needed.
If this information is not given, an implementation should avoid using SPIs and instead use declarative services for dependency injection as specified by OSGi. Note that this also applies to several newInstance() methods in the Java API.
The class that created an instance with SPI must call this method before putting it to use.
-
-