Package com.day.cq.wcm.foundation.forms

Class MergedValueMap

java.lang.Object
com.day.cq.wcm.foundation.forms.MergedValueMap
All Implemented Interfaces:
Map<String,Object>, ValueMap
public class MergedValueMap extends Object implements ValueMap
MergedValueMap merges the values of the value maps from multiple resources. It merges the values of all value maps behind the resources, ie. provides a null value for a key if the value is not the same in all resources and only presents a value if that one is present in exactly all of the resources.

It is optimized for the forms module, ie. on calls to get(String, Class) with String[] as type (see FormsHelper.getValues(org.apache.sling.api.SlingHttpServletRequest, Resource) ).

Note: this class is not synchronized, ie. not thread-safe.

  • Constructor Details

    • MergedValueMap

      public MergedValueMap(List<Resource> resources)

  • Method Details

    • get

      public Object get(Object key)
      Specified by:
      get in interface Map<String,Object>

    • get

      public <T> T get(String name, Class<T> type)
      Description copied from interface: ValueMap
      Get a named property and convert it into the given type. This method does not support conversion into a primitive type or an array of a primitive type. It should return null in this case.
      Specified by:
      get in interface ValueMap
      Type Parameters:
      T - The class of the type
      Parameters:
      name - The name of the property
      type - The class of the type
      Returns:
      Return named value converted to type T or null if non existing or can't be converted.

    • get

      public <T> T get(String name, T defaultValue)
      Description copied from interface: ValueMap
      Get a named property and convert it into the given type. This method does not support conversion into a primitive type or an array of a primitive type. It should return the default value in this case.

      Implementation hint: In the past it was allowed to call this with a 2nd parameter being null. Therefore all implementations should internally call Map.get(Object) when the 2nd parameter has value null.
      Specified by:
      get in interface ValueMap
      Type Parameters:
      T - The expected type
      Parameters:
      name - The name of the property
      defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. Must not be null. If you want to return null by default rather rely on ValueMap.get(String, Class).
      Returns:
      Return named value converted to type T or the default value if non existing or can't be converted.

    • size

      public int size()
      Specified by:
      size in interface Map<String,Object>

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface Map<String,Object>

    • containsKey

      public boolean containsKey(Object key)
      Specified by:
      containsKey in interface Map<String,Object>

    • containsValue

      public boolean containsValue(Object value)
      Specified by:
      containsValue in interface Map<String,Object>

    • entrySet

      public Set<Map.Entry<String,Object>> entrySet()
      Specified by:
      entrySet in interface Map<String,Object>

    • keySet

      public Set<String> keySet()
      Specified by:
      keySet in interface Map<String,Object>

    • values

      public Collection<Object> values()
      Specified by:
      values in interface Map<String,Object>

    • clear

      public void clear()
      Specified by:
      clear in interface Map<String,Object>

    • put

      public Object put(String key, Object value)
      Specified by:
      put in interface Map<String,Object>

    • putAll

      public void putAll(Map<? extends String,? extends Object> t)
      Specified by:
      putAll in interface Map<String,Object>

    • remove

      public Object remove(Object key)
      Specified by:
      remove in interface Map<String,Object>