com.adobe.granite.ui.components

Class BulkEditValueMap

java.lang.Object

com.adobe.granite.ui.components.BulkEditValueMap

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>, ValueMap

public class BulkEditValueMap
extends java.lang.Object
implements ValueMap

BulkEditValueMap is a ValueMap specific to the needs of Bulk Editing. It is aimed at merging the given Resources' ValueMaps.

Please not that the merge is actually "virtual" since under the hood the ValueMap will always be empty. In other words, get(Object key) performs an on-demand merge for the passed key.

In addition to providing the actual (merged) value for a given key, this specific ValueMap can also tell if a given key has a mixed value using #get(key + Field.IS_MIXED_SUFFIX).

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
BulkEditValueMap(java.util.List<Resource> resources)
BulkEditValueMap(java.util.List<Resource> resources, java.util.Map<java.lang.String,ValueFetchStrategy> fetchStrategies)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	entrySet()
java.lang.Object	get(java.lang.Object key) Retrieves the merged value for the passed 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.
boolean	isEmpty()
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,? extends java.lang.Object> t)
java.lang.Object	remove(java.lang.Object key)
int	size()
java.util.Collection<java.lang.Object>	values()

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

BulkEditValueMap

public BulkEditValueMap(@Nonnull
                        java.util.List<Resource> resources)

BulkEditValueMap

public BulkEditValueMap(@Nonnull
                        java.util.List<Resource> resources,
                        @Nonnull
                        java.util.Map<java.lang.String,ValueFetchStrategy> fetchStrategies)

Method Detail

get

public java.lang.Object get(java.lang.Object key)

Retrieves the merged value for the passed key. Calling #get(key + Field.IS_MIXED_SUFFIX) returns true if the value is mixed; false otherwise. If the value is non-existent null is returned.

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

Parameters:

key - The key of the value to retrieve.

Returns:

The merged value for the passed key; or a boolean telling if the value is mixed or not (if the key ends with Field.IS_MIXED_SUFFIX).

get

public <T> T get(@Nonnull
                 java.lang.String name,
                 @Nonnull
                 java.lang.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

@Nonnull
public <T> T get(@Nonnull
                          java.lang.String name,
                          @Nonnull
                          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 java.util.Map<java.lang.String,java.lang.Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.Object>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.Object>

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.Object>

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>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>

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>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> t)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.Object>

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>