Package org.daisy.dotify.api.translator

Interface BrailleTranslatorFactoryService

  • 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 Detail

      • supportsSpecification

        boolean supportsSpecification​(String locale,
                              String mode)
        Returns true if the translator factory supports the given specification.
        Parameters:
        locale - the translator locale
        mode - the translator grade, or null for uncontracted braille
        Returns:
        returns true if the translator factory supports the specification

      • 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.