Interface ConfigurationMetadataRetriever<T>

  • Type Parameters:
    T - the target configuration data type
    All Known Implementing Classes:
    Configuration, ConfigurationBuilder

    public interface ConfigurationMetadataRetriever<T>
    A base interface for objects that retrieve configuration metadata, such as Source, Mapper, and other attributes.
    Since:
    0.1.0
    Author:
    oswaldo.bapvic.jr (Oswaldo Junior)
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Mapper<T> getMapper()
      Returns the Mapper object associated with this Configuration.
      String getNamespace()
      Returns the namespace defined for this Configuration object.
      int getPrecedence()
      Returns the precedence value defined for this Configuration object.
      Source<T> getSource()
      Returns the Source object associated with this Configuration.
      boolean isLazy()
      Returns a flag indicating whether this Configuration is lazy, i.e., not loaded until needed.
      boolean isOptional()
      Returns a flag indicating whether this Configuration is optional.
    • Method Detail

      • getNamespace

        String getNamespace()
        Returns the namespace defined for this Configuration object.
        Returns:
        the namespace defined for this Configuration
      • getPrecedence

        int getPrecedence()
        Returns the precedence value defined for this Configuration object.

        In a common container, objects with higher-precedence may be selected first in case of key collision.

        Returns:
        an integer number representing the order of importance given to this Configuration
      • getSource

        Source<T> getSource()
        Returns the Source object associated with this Configuration.
        Returns:
        a Source instance
      • getMapper

        Mapper<T> getMapper()
        Returns the Mapper object associated with this Configuration.
        Returns:
        a Mapper instance
      • isOptional

        boolean isOptional()
        Returns a flag indicating whether this Configuration is optional.

        An optional Configuration object may behave quietly in the event of a failure to load the data.

        Returns:
        true if this Configuration setup is optional; false, otherwise
      • isLazy

        boolean isLazy()
        Returns a flag indicating whether this Configuration is lazy, i.e., not loaded until needed.
        Returns:
        true if this Configuration is lazy; false, otherwise
        Since:
        0.4.0