Class PropertyMap

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>

    public final class PropertyMap
    extends BaseTypesMap<java.lang.String,​java.lang.Object>
    implements java.lang.Cloneable, java.io.Serializable
    Map for storing properties.

    Provides convenient type conversion get methods that take default values.

    NOTE: keys are treated as case insensitive.

    See Also:
    Serialized Form
    • 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>
    • Constructor Summary

      Constructors 
      Constructor Description
      PropertyMap()  
      PropertyMap​(int initialCapacity)  
      PropertyMap​(java.util.Map<? extends java.lang.String,​? extends java.lang.Object> m)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PropertyMap clone()
      Performs a deep clone of this map.
      boolean containsKey​(java.lang.Object key)  
      java.lang.Object get​(java.lang.Object key)  
      boolean get​(java.lang.String key, boolean defaultValue)
      Get a boolean value for key.
      double get​(java.lang.String key, double defaultValue)
      Get a double value for key.
      float get​(java.lang.String key, float defaultValue)
      Get a float value for key.
      int get​(java.lang.String key, int defaultValue)
      Get an int value for key.
      long get​(java.lang.String key, long defaultValue)
      Get a long value for key.
      java.lang.Object get​(java.lang.String key, java.lang.Object defaultValue)
      Get an Object value for key.
      java.lang.String get​(java.lang.String key, java.lang.String defaultValue)
      Get a String value for key.
      static boolean get​(java.util.Map<java.lang.String,​?> map, java.lang.String key, boolean defaultValue)
      Get a boolean value from map for key returning defaultValue if key is not found.
      static double get​(java.util.Map<java.lang.String,​?> map, java.lang.String key, double defaultValue)
      Get a double value from map for key returning defaultValue if key is not found.
      static float get​(java.util.Map<java.lang.String,​?> map, java.lang.String key, float defaultValue)
      Get a float value from map for key returning defaultValue if key is not found.
      static int get​(java.util.Map<java.lang.String,​?> map, java.lang.String key, int defaultValue)
      Get an int value from map for key returning defaultValue if key is not found.
      static long get​(java.util.Map<java.lang.String,​?> map, java.lang.String key, long defaultValue)
      Get a long value from map for key returning defaultValue if key is not found.
      static java.lang.Object get​(java.util.Map<java.lang.String,​?> map, java.lang.String key, java.lang.Object defaultValue)
      Get an Object value from map for key returning defaultValue if key is not found.
      static java.lang.String get​(java.util.Map<java.lang.String,​?> map, java.lang.String key, java.lang.String defaultValue)
      Get a String value from map for key returning defaultValue if key is not found.
      java.lang.String prettyFormat()
      Pretty format this PropertyMap.
      void prettyFormat​(java.lang.StringBuilder buffer, int indent)
      Pretty format this PropertyMap.
      void prettyFormat​(java.lang.StringBuilder buffer, int indent, java.util.Set<java.lang.String> exclude)
      Pretty format this PropertyMap.
      java.lang.Object put​(java.lang.String key, java.lang.Object value)  
      void putAll​(java.util.Map<? extends java.lang.String,​? extends java.lang.Object> m)  
      void putAll​(java.util.Map<java.lang.String,​?> map, boolean override)
      Put all entries from map into this property map.
      • Methods inherited from class java.util.LinkedHashMap

        clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values
      • Methods inherited from class java.util.HashMap

        compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putIfAbsent, remove, remove, replace, replace, size
      • Methods inherited from class java.util.AbstractMap

        equals, hashCode, toString
      • Methods inherited from class java.lang.Object

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

        compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putIfAbsent, remove, remove, replace, replace, size
    • Constructor Detail

      • PropertyMap

        public PropertyMap()
      • PropertyMap

        public PropertyMap​(int initialCapacity)
      • PropertyMap

        public PropertyMap​(java.util.Map<? extends java.lang.String,​? extends java.lang.Object> m)
    • Method Detail

      • get

        public boolean get​(java.lang.String key,
                           boolean defaultValue)
        Get a boolean value for key.
      • get

        public int get​(java.lang.String key,
                       int defaultValue)
        Get an int value for key.
      • get

        public long get​(java.lang.String key,
                        long defaultValue)
        Get a long value for key.
      • get

        public float get​(java.lang.String key,
                         float defaultValue)
        Get a float value for key.
      • get

        public double get​(java.lang.String key,
                          double defaultValue)
        Get a double value for key.
      • get

        public java.lang.String get​(java.lang.String key,
                                    java.lang.String defaultValue)
        Get a String value for key.
      • get

        public java.lang.Object get​(java.lang.String key,
                                    java.lang.Object defaultValue)
        Get an Object value for key.
      • get

        public static boolean get​(java.util.Map<java.lang.String,​?> map,
                                  java.lang.String key,
                                  boolean defaultValue)
        Get a boolean value from map for key returning defaultValue if key is not found.
      • get

        public static int get​(java.util.Map<java.lang.String,​?> map,
                              java.lang.String key,
                              int defaultValue)
        Get an int value from map for key returning defaultValue if key is not found.
      • get

        public static long get​(java.util.Map<java.lang.String,​?> map,
                               java.lang.String key,
                               long defaultValue)
        Get a long value from map for key returning defaultValue if key is not found.
      • get

        public static float get​(java.util.Map<java.lang.String,​?> map,
                                java.lang.String key,
                                float defaultValue)
        Get a float value from map for key returning defaultValue if key is not found.
      • get

        public static double get​(java.util.Map<java.lang.String,​?> map,
                                 java.lang.String key,
                                 double defaultValue)
        Get a double value from map for key returning defaultValue if key is not found.
      • get

        public static java.lang.String get​(java.util.Map<java.lang.String,​?> map,
                                           java.lang.String key,
                                           java.lang.String defaultValue)
        Get a String value from map for key returning defaultValue if key is not found.
      • get

        public static java.lang.Object get​(java.util.Map<java.lang.String,​?> map,
                                           java.lang.String key,
                                           java.lang.Object defaultValue)
        Get an Object value from map for key returning defaultValue if key is not found.
      • prettyFormat

        public java.lang.String prettyFormat()
        Pretty format this PropertyMap.
      • prettyFormat

        public void prettyFormat​(java.lang.StringBuilder buffer,
                                 int indent)
        Pretty format this PropertyMap.
        Parameters:
        buffer - buffer to write pretty formated representation to.
        indent - the indentation level
      • prettyFormat

        public void prettyFormat​(java.lang.StringBuilder buffer,
                                 int indent,
                                 java.util.Set<java.lang.String> exclude)
        Pretty format this PropertyMap.
        Parameters:
        buffer - buffer to write pretty formated representation to.
        indent - the indentation level
        exclude - the parameters to not format
      • putAll

        public void putAll​(java.util.Map<java.lang.String,​?> map,
                           boolean override)
        Put all entries from map into this property map.

        If override is false, values specified in map will not override values in this property map if they share a key.

      • put

        public java.lang.Object put​(java.lang.String key,
                                    java.lang.Object value)
        Specified by:
        put in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        put in class BaseTypesMap<java.lang.String,​java.lang.Object>
      • putAll

        public void putAll​(java.util.Map<? extends java.lang.String,​? extends java.lang.Object> m)
        Specified by:
        putAll in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        putAll in class BaseTypesMap<java.lang.String,​java.lang.Object>
      • containsKey

        public boolean containsKey​(java.lang.Object key)
        Specified by:
        containsKey in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        containsKey in class java.util.HashMap<java.lang.String,​java.lang.Object>
      • get

        public java.lang.Object get​(java.lang.Object key)
        Specified by:
        get in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        get in class java.util.LinkedHashMap<java.lang.String,​java.lang.Object>