Class ConfigurationMap

  • All Implemented Interfaces:
    java.util.Map<java.lang.Object,​java.lang.Object>
    Direct Known Subclasses:
    ConfigurationDynaBean

    public class ConfigurationMap
    extends java.util.AbstractMap<java.lang.Object,​java.lang.Object>

    The ConfigurationMap wraps a configuration-collection Configuration instance to provide a Map interface.

    Note: This implementation is incomplete.

    Since:
    1.0
    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>
      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
    • Constructor Summary

      Constructors 
      Constructor Description
      ConfigurationMap​(Configuration configuration)
      Creates a new instance of a ConfigurationMap that wraps the specified Configuration instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Set<java.util.Map.Entry<java.lang.Object,​java.lang.Object>> entrySet()
      Returns a set with the entries contained in this configuration-based map.
      java.lang.Object get​(java.lang.Object key)
      Gets the value of the specified key.
      Configuration getConfiguration()
      Gets the wrapped Configuration object.
      java.lang.Object put​(java.lang.Object key, java.lang.Object value)
      Stores the value for the specified key.
      • Methods inherited from class java.util.AbstractMap

        clear, clone, containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, remove, size, toString, values
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
    • Constructor Detail

      • ConfigurationMap

        public ConfigurationMap​(Configuration configuration)
        Creates a new instance of a ConfigurationMap that wraps the specified Configuration instance.
        Parameters:
        configuration - Configuration instance.
    • Method Detail

      • getConfiguration

        public Configuration getConfiguration()
        Gets the wrapped Configuration object.
        Returns:
        the wrapped configuration
        Since:
        1.2
      • entrySet

        public java.util.Set<java.util.Map.Entry<java.lang.Object,​java.lang.Object>> entrySet()
        Returns a set with the entries contained in this configuration-based map.
        Specified by:
        entrySet in interface java.util.Map<java.lang.Object,​java.lang.Object>
        Specified by:
        entrySet in class java.util.AbstractMap<java.lang.Object,​java.lang.Object>
        Returns:
        a set with the contained entries
        See Also:
        Map.entrySet()
      • put

        public java.lang.Object put​(java.lang.Object key,
                                    java.lang.Object value)
        Stores the value for the specified key. The value is stored in the underlying configuration.
        Specified by:
        put in interface java.util.Map<java.lang.Object,​java.lang.Object>
        Overrides:
        put in class java.util.AbstractMap<java.lang.Object,​java.lang.Object>
        Parameters:
        key - the key (will be converted to a string)
        value - the value
        Returns:
        the old value of this key or null if it is new
        See Also:
        Map.put(Object, Object)
      • get

        public java.lang.Object get​(java.lang.Object key)
        Gets the value of the specified key. The key is converted to a string and then passed to the underlying configuration.
        Specified by:
        get in interface java.util.Map<java.lang.Object,​java.lang.Object>
        Overrides:
        get in class java.util.AbstractMap<java.lang.Object,​java.lang.Object>
        Parameters:
        key - the key
        Returns:
        the value of this key
        See Also:
        Map.get(Object)