Class AbstractMultivaluedMap<K,V>
- java.lang.Object
-
- jakarta.ws.rs.core.AbstractMultivaluedMap<K,V>
-
- Type Parameters:
K
- the type of keys maintained by this map.V
- the type of mapped values.
- All Implemented Interfaces:
MultivaluedMap<K,V>
,Serializable
,Map<K,List<V>>
- Direct Known Subclasses:
MultivaluedHashMap
public abstract class AbstractMultivaluedMap<K,V> extends Object implements MultivaluedMap<K,V>, Serializable
Abstract skeleton implementation of aMultivaluedMap
that is backed by a [key, multi-value] store represented as aMap<K, List<V>>
.- Author:
- Marek Potociar
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AbstractMultivaluedMap(Map<K,List<V>> store)
Initialize the backing store in the abstract parent multivalued map implementation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(K key, V value)
Add a value to the current list of values for the supplied key.void
addAll(K key, List<V> valueList)
Add all the values from the supplied value list to the current list of values for the supplied key.void
addAll(K key, V... newValues)
Add multiple values to the current list of values for the supplied key.void
addFirst(K key, V value)
Add a value to the first position in the current list of values for the supplied key.protected void
addFirstNull(List<V> values)
Define the behavior for adding anull
values to the first position in the value list.protected void
addNull(List<V> values)
Define the behavior for adding anull
values to the value list.void
clear()
boolean
containsKey(Object key)
boolean
containsValue(Object value)
Set<Map.Entry<K,List<V>>>
entrySet()
boolean
equals(Object o)
boolean
equalsIgnoreValueOrder(MultivaluedMap<K,V> omap)
Compare the specified map with this map for equality modulo the order of values for each key.List<V>
get(Object key)
V
getFirst(K key)
A shortcut to get the first value of the supplied key.protected List<V>
getValues(K key)
Return a non-null list of values for a given key.int
hashCode()
boolean
isEmpty()
Set<K>
keySet()
List<V>
put(K key, List<V> value)
void
putAll(Map<? extends K,? extends List<V>> m)
void
putSingle(K key, V value)
Set the value for the key to be a one item list consisting of the supplied value.List<V>
remove(Object key)
int
size()
String
toString()
Collection<List<V>>
values()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Constructor Detail
-
AbstractMultivaluedMap
public AbstractMultivaluedMap(Map<K,List<V>> store)
Initialize the backing store in the abstract parent multivalued map implementation.- Parameters:
store
- the backingMap
to be used as a [key, multi-value] store. Must not benull
.- Throws:
NullPointerException
- in case the underlyingstore
parameter isnull
.
-
-
Method Detail
-
putSingle
public final void putSingle(K key, V value)
Set the value for the key to be a one item list consisting of the supplied value. Any existing values will be replaced.
NOTE: This implementation ignoresnull
values; A supplied value ofnull
is ignored and not added to the purged value list. As a result of such operation, empty value list would be registered for the supplied key. Overriding implementations may modify this behavior by redefining theaddNull(java.util.List)
method.- Specified by:
putSingle
in interfaceMultivaluedMap<K,V>
- Parameters:
key
- the keyvalue
- the single value of the key. If the value isnull
it will be ignored.
-
addNull
protected void addNull(List<V> values)
Define the behavior for adding a
Default implementation is a no-op, i.e. thenull
values to the value list.null
values are ignored. Overriding implementations may modify this behavior by providing their own definitions of this method.- Parameters:
values
- value list where thenull
value addition is being requested.
-
addFirstNull
protected void addFirstNull(List<V> values)
Define the behavior for adding a
Default implementation is a no-op, i.e. thenull
values to the first position in the value list.null
values are ignored. Overriding implementations may modify this behavior by providing their own definitions of this method.- Parameters:
values
- value list where thenull
value addition is being requested.
-
add
public final void add(K key, V value)
Add a value to the current list of values for the supplied key.
NOTE: This implementation ignoresnull
values; A supplied value ofnull
is ignored and not added to the value list. Overriding implementations may modify this behavior by redefining theaddNull(java.util.List)
method.- Specified by:
add
in interfaceMultivaluedMap<K,V>
- Parameters:
key
- the keyvalue
- the value to be added.
-
addAll
public final void addAll(K key, V... newValues)
Add multiple values to the current list of values for the supplied key. If the supplied array of new values is empty, method returns immediately. Method throws a
NOTE: This implementation ignoresNullPointerException
if the supplied array of values isnull
.null
values; Any of the supplied values ofnull
is ignored and not added to the value list. Overriding implementations may modify this behavior by redefining theaddNull(java.util.List)
method.- Specified by:
addAll
in interfaceMultivaluedMap<K,V>
- Parameters:
key
- the key.newValues
- the values to be added.- Throws:
NullPointerException
- if the supplied array of new values isnull
.
-
addAll
public final void addAll(K key, List<V> valueList)
Add all the values from the supplied value list to the current list of values for the supplied key. If the supplied value list is empty, method returns immediately. Method throws a
NOTE: This implementation ignoresNullPointerException
if the supplied array of values isnull
.null
values; Anynull
value in the supplied value list is ignored and not added to the value list. Overriding implementations may modify this behavior by redefining theaddNull(java.util.List)
method.- Specified by:
addAll
in interfaceMultivaluedMap<K,V>
- Parameters:
key
- the key.valueList
- the list of values to be added.- Throws:
NullPointerException
- if the supplied value list isnull
.
-
getFirst
public final V getFirst(K key)
Description copied from interface:MultivaluedMap
A shortcut to get the first value of the supplied key.- Specified by:
getFirst
in interfaceMultivaluedMap<K,V>
- Parameters:
key
- the key- Returns:
- the first value for the specified key or null if the key is not in the map.
-
addFirst
public final void addFirst(K key, V value)
Add a value to the first position in the current list of values for the supplied key.
NOTE: This implementation ignoresnull
values; A supplied value ofnull
is ignored and not added to the purged value list. Overriding implementations may modify this behavior by redefining theaddFirstNull(java.util.List)
method.- Specified by:
addFirst
in interfaceMultivaluedMap<K,V>
- Parameters:
key
- the keyvalue
- the value to be added.
-
getValues
protected final List<V> getValues(K key)
Return a non-null list of values for a given key. The returned list may be empty.
If there is no entry for the key in the map, a new emptyList
instance is created, registered within the map to hold the values of the key and returned from the method.- Parameters:
key
- the key.- Returns:
- value list registered with the key. The method is guaranteed to never return
null
.
-
hashCode
public int hashCode()
This implementation delegates the method call to to the the underlying [key, multi-value] store.
-
equals
public boolean equals(Object o)
This implementation delegates the method call to to the the underlying [key, multi-value] store.
-
containsValue
public boolean containsValue(Object value)
- Specified by:
containsValue
in interfaceMap<K,V>
-
containsKey
public boolean containsKey(Object key)
- Specified by:
containsKey
in interfaceMap<K,V>
-
equalsIgnoreValueOrder
public boolean equalsIgnoreValueOrder(MultivaluedMap<K,V> omap)
Description copied from interface:MultivaluedMap
Compare the specified map with this map for equality modulo the order of values for each key. Specifically, the values associated with each key are compared as if they were ordered lists.- Specified by:
equalsIgnoreValueOrder
in interfaceMultivaluedMap<K,V>
- Parameters:
omap
- map to be compared to this one.- Returns:
- true if the maps are equal modulo value ordering.
-
-