Package org.apache.sling.api.wrappers.impl

Class MergingValueMap

java.lang.Object

org.apache.sling.api.wrappers.impl.MergingValueMap

All Implemented Interfaces:

Map<String,Object>, ValueMap

public class MergingValueMap
extends Object
implements ValueMap

Merge provided ValueMaps into a single view ValueMap that aggregates all key-value pairs of the given maps. The value for a key-value pair is taken from the first ValueMap (in iteration order) that has a mapping for the given key.
In case you would like to avoid duplicating properties on multiple resources, you can use a MergingValueMap to get a concatenated map of properties.

See Also:

ValueMapUtil.merge(List), ValueMapUtil.merge(ValueMap...), ValueMapUtil.mergeAndCache(List)

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
MergingValueMap(@NotNull List<ValueMap> valueMaps)	Constructor that allows merging any number of ValueMap instances into a single ValueMap view.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
@NotNull Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
boolean	isEmpty()
@NotNull Set<String>	keySet()
Object	put(String aKey, Object value)
void	putAll(Map<? extends String,?> properties)
Object	remove(Object key)
int	size()
@NotNull Collection<Object>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

Methods inherited from interface org.apache.sling.api.resource.ValueMap

get, get

Constructor Detail

MergingValueMap

public MergingValueMap(@NotNull
                       @NotNull List<ValueMap> valueMaps)

Constructor that allows merging any number of ValueMap instances into a single ValueMap view. The keys of the view are the union of the keys of all value maps. The values of the view is the mapping of all keys to their respective value. The entries are the key-value pairs. Values are retrieved by getting the value for a key for each ValueMap until a non-null value is found.

Parameters:

valueMaps - The ValueMaps to be merged.

See Also:

ValueMapUtil.merge(List), ValueMapUtil.merge(ValueMap...)

Method Detail

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>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

keySet

@NotNull
public @NotNull Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

values

@NotNull
public @NotNull Collection<Object> values()

Specified by:

values in interface Map<String,Object>

entrySet

@NotNull
public @NotNull Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

put

public Object put(String aKey,
                  Object value)

Specified by:

put in interface Map<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

putAll

public void putAll(Map<? extends String,?> properties)

Specified by:

putAll in interface Map<String,Object>

clear

public void clear()

Specified by:

clear in interface Map<String,Object>