org.apache.tiles.core.definition

## Interface DefinitionsReader

- All Known Implementing Classes:
    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.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,Definition>` | `read(Object source)` Reads ``Definition`` objects from a source.

- - ### Method Detail

    - #### read

          Map<String,Definition> read(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.

Copyright © 2000–2024 Apache Software Foundation. All rights reserved.