Interface DefinitionsReader

  • All Known Implementing Classes:
    CompatibilityDigesterDefinitionsReader, DigesterDefinitionsReader

    public interface DefinitionsReader
    Interface for reading Definition from a source.

    This interface provides a standard way to read Definition objects from a source. Implementations should define what the source is, whether it be a persistent store such as a configuration file or database, or something like a web service. The DefinitionsReader is responsible for reading from a single location. It does not perform any internationalization duties or inheritance of Definitions. It only reads from the source and returns a Map of objects read.

    Version:
    $Rev: 829574 $ $Date: 2009-10-26 01:15:31 +1100 (Mon, 26 Oct 2009) $
    • Method Detail

      • read

        java.util.Map<java.lang.String,​Definition> read​(java.lang.Object source)
        Reads Definition objects from a source.

        Implementations should publish what type of source object is expected.

        Parameters:
        source - The source from which definitions will be read.
        Returns:
        a Map of Definition objects read from the source.
        Throws:
        DefinitionsFactoryException - if the source is invalid or an error occurs when reading definitions.