Interface FileFormatProvider

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      FileFormat newFactory​(String identifier)
      Creates a new file format with the specified identifier.
      void setCreatedWithSPI()
      Informs the implementation that it was discovered and instantiated using information collected from a file within the META-INF/services directory.
      • Methods inherited from interface org.daisy.dotify.api.factory.Provider

        list
    • Method Detail

      • setCreatedWithSPI

        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.

      • newFactory

        FileFormat newFactory​(String identifier)
        Creates a new file format with the specified identifier.
        Parameters:
        identifier - the identifier
        Returns:
        returns a new file format