Package org.apache.sling.api.wrappers
Class CompositeValueMap
- java.lang.Object
-
- org.apache.sling.api.wrappers.CompositeValueMap
-
@Deprecated public class CompositeValueMap extends Object implements ValueMap
Deprecated.UseValueMapUtil.merge(ValueMap...)
instead. Note that it does not support the parametermerge = false
. However, this could easily be achieved with another decorator that restricts the set of allowed keys.An implementation of theValueMap
based on twoValueMap
s: - One containing the properties - Another one containing the defaults to use in case the properties map does not contain the values. In case you would like to avoid duplicating properties on multiple resources, you can use aCompositeValueMap
to get a concatenated map of properties.- Since:
- 2.3 (Sling API Bundle 2.5.0)
-
-
Constructor Summary
Constructors Constructor Description CompositeValueMap(ValueMap properties, ValueMap defaults)
Deprecated.ConstructorCompositeValueMap(ValueMap properties, ValueMap defaults, boolean merge)
Deprecated.Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
clear()
Deprecated.boolean
containsKey(Object key)
Deprecated.boolean
containsValue(Object value)
Deprecated.Set<Map.Entry<String,Object>>
entrySet()
Deprecated.<T> T
get(@NotNull String name, @NotNull Class<T> type)
Deprecated.Get a named property and convert it into the given type.<T> T
get(@NotNull String name, T defaultValue)
Deprecated.Get a named property and convert it into the given type.Object
get(Object key)
Deprecated.boolean
isEmpty()
Deprecated.Set<String>
keySet()
Deprecated.Object
put(String aKey, Object value)
Deprecated.void
putAll(Map<? extends String,?> properties)
Deprecated.Object
remove(Object key)
Deprecated.int
size()
Deprecated.Collection<Object>
values()
Deprecated.-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Constructor Detail
-
CompositeValueMap
public CompositeValueMap(ValueMap properties, ValueMap defaults)
Deprecated.Constructor
-
CompositeValueMap
public CompositeValueMap(ValueMap properties, ValueMap defaults, boolean merge)
Deprecated.Constructor- Parameters:
properties
- TheValueMap
to read fromdefaults
- The defaultValueMap
to use as fallbackmerge
- Merge flag - Iftrue
, getting a key would return the current property map's value (if available), even if the corresponding default does not exist. - Iffalse
, getting a key would returnnull
if the corresponding default does not exist
-
-
Method Detail
-
get
@Nullable public <T> T get(@NotNull @NotNull String name, @NotNull @NotNull Class<T> type)
Deprecated.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 returnnull
in this case.
-
get
@NotNull public <T> T get(@NotNull @NotNull String name, @NotNull T defaultValue)
Deprecated.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 beingnull
. Therefore all implementations should internally callMap.get(Object)
when the 2nd parameter has valuenull
.- Specified by:
get
in interfaceValueMap
- Type Parameters:
T
- The expected type- Parameters:
name
- The name of the propertydefaultValue
- 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 benull
. If you want to returnnull
by default rather rely onValueMap.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(Object key)
Deprecated.- Specified by:
containsKey
in interfaceMap<String,Object>
-
containsValue
public boolean containsValue(Object value)
Deprecated.- Specified by:
containsValue
in interfaceMap<String,Object>
-
values
public Collection<Object> values()
Deprecated.
-
-