Package com.adobe.granite.rest.utils

Class DeepModifiableValueMapDecorator

  • All Implemented Interfaces:
    java.util.Map<java.lang.String,​java.lang.Object>, ModifiableValueMap, ValueMap
    public class DeepModifiableValueMapDecorator
extends ModifiableValueMapDecorator
    A value map wrapper which implements deep reading/writing of properties based on the resource tree and a set of exposed sub-nodes. Note that only properties of exposed sub-nodes can be updated.

    • Nested Class Summary

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

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

    • Field Summary

      • Fields inherited from interface org.apache.sling.api.resource.ValueMap

        EMPTY

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean containsKey​(java.lang.Object key)
      java.util.Set<java.util.Map.Entry<java.lang.String,​java.lang.Object>> entrySet()
      java.lang.Object get​(java.lang.Object key)
      <T> T get​(java.lang.String name, java.lang.Class<T> type)
      Get a named property and convert it into the given type.
      <T> T get​(java.lang.String name, T defaultValue)
      Get a named property and convert it into the given type.
      java.util.Set<java.lang.String> keySet()
      java.lang.Object put​(java.lang.String key, java.lang.Object value)
      void putAll​(java.util.Map<? extends java.lang.String,​?> t)
      java.util.Collection<java.lang.Object> values()

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsValue, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size

    • Constructor Detail

      • DeepModifiableValueMapDecorator

        public DeepModifiableValueMapDecorator​(Resource resource,
                                       java.util.Map<java.lang.String,​java.lang.Object> base,
                                       java.lang.String[] subnodes)

      • DeepModifiableValueMapDecorator

        public DeepModifiableValueMapDecorator​(Resource resource,
                                       java.util.Map<java.lang.String,​java.lang.Object> base)

    • Method Detail

      • get

        public <T> T get​(java.lang.String name,
                 java.lang.Class<T> type)
        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
        Overrides:
        get in class ValueMapDecorator
        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​(java.lang.String name,
                 T defaultValue)
        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
        Overrides:
        get in class ValueMapDecorator
        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.

      • 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 ValueMapDecorator

      • 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 ValueMapDecorator

      • 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 ValueMapDecorator

      • putAll

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

      • keySet

        public java.util.Set<java.lang.String> keySet()
        Specified by:
        keySet in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        keySet in class ValueMapDecorator

      • values

        public java.util.Collection<java.lang.Object> values()
        Specified by:
        values in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        values in class ValueMapDecorator

      • entrySet

        public java.util.Set<java.util.Map.Entry<java.lang.String,​java.lang.Object>> entrySet()
        Specified by:
        entrySet in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        entrySet in class ValueMapDecorator