Package com.hybris.cockpitng.core.util.impl

Class TypedSettingsMap

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
    public class TypedSettingsMap
extends java.util.HashMap<java.lang.String,​java.lang.Object>
    Manages widget settings provided via a widget's definition.xml or at runtime.
    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>

      • Nested classes/interfaces inherited from interface java.util.Map

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object get​(java.lang.Object key)  
      java.util.Map<java.lang.String,​java.lang.Object> getAll()  
      java.util.List<java.lang.String> getAvailableValues​(java.lang.String key)  
      boolean getBoolean​(java.lang.Object key)  
      double getDouble​(java.lang.Object key)  
      int getInt​(java.lang.Object key)  
      java.lang.Object getOrDefault​(java.lang.Object key, java.lang.Object defaultValue)  
      java.lang.String getRaw​(java.lang.Object key)  
      java.lang.Class getSettingClass​(java.lang.String key)  
      java.lang.String getString​(java.lang.Object key)  
      java.lang.Object getTyped​(java.lang.Object key)  
      boolean isEnum​(java.lang.String key)  
      java.lang.Object parseIfSetting​(java.lang.String component, java.lang.String key, java.lang.Object val)
      Checks if the 'key' represents a component's (editor, action) setting defined in definition.xml.
      java.lang.Object put​(java.lang.String key, java.lang.Object value)
      Add an entry and assign type info to its value as prefix.
      java.lang.Object put​(java.lang.String key, java.lang.Object value, java.lang.Class type)  
      java.lang.Object putRaw​(java.lang.String key, java.lang.Object value)
      Add entry without performing any transformations.
      void setAvailableValues​(java.lang.String key, java.util.List<java.lang.String> values)  

      • Methods inherited from class java.util.HashMap

        clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

      • 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

        equals, hashCode

    • Constructor Detail

      • TypedSettingsMap

        public TypedSettingsMap()

    • Method Detail

      • put

        public java.lang.Object put​(java.lang.String key,
                            java.lang.Object value)
        Add an entry and assign type info to its value as prefix.
        Specified by:
        put in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        put in class java.util.HashMap<java.lang.String,​java.lang.Object>
        Returns:
        the value that has been assigned to the specified key.

      • put

        public java.lang.Object put​(java.lang.String key,
                            java.lang.Object value,
                            java.lang.Class type)

      • 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.HashMap<java.lang.String,​java.lang.Object>

      • getOrDefault

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

      • getTyped

        public java.lang.Object getTyped​(java.lang.Object key)

      • isEnum

        public boolean isEnum​(java.lang.String key)

      • getAvailableValues

        public java.util.List<java.lang.String> getAvailableValues​(java.lang.String key)

      • setAvailableValues

        public void setAvailableValues​(java.lang.String key,
                               java.util.List<java.lang.String> values)

      • getAll

        public java.util.Map<java.lang.String,​java.lang.Object> getAll()

      • getRaw

        public java.lang.String getRaw​(java.lang.Object key)

      • putRaw

        public java.lang.Object putRaw​(java.lang.String key,
                               java.lang.Object value)
        Add entry without performing any transformations.
        Returns:
        the value that has been assigned to key

      • getBoolean

        public boolean getBoolean​(java.lang.Object key)

      • getString

        public java.lang.String getString​(java.lang.Object key)

      • getInt

        public int getInt​(java.lang.Object key)

      • getDouble

        public double getDouble​(java.lang.Object key)

      • parseIfSetting

        public java.lang.Object parseIfSetting​(java.lang.String component,
                                       java.lang.String key,
                                       java.lang.Object val)
        Checks if the 'key' represents a component's (editor, action) setting defined in definition.xml. If so, tries to parse the 'val' into the appropriate class (like Integer, Double, Boolean, etc) if it is a string. If it is not a setting, or is already of the required class, returns the 'val'.

      • getSettingClass

        public java.lang.Class getSettingClass​(java.lang.String key)