Jakarta EE 11.0.0 · jakarta.ws.rs.core.AbstractMultivaluedMap

Modifier and Type	Field and Description
protected final Map<K, List<V>>	store Backing store for the [key, multi-value] pairs.

Access	Constructor and Description
public	AbstractMultivaluedMap(final Map<K, List<V>> the backing `Map` to be used as a [key, multi-value] store. Must not be `null`. store) Initialize the backing store in the abstract parent multivalued map implementation.

Method Summary

Modifier and Type	Method and Description
public final void	add(final K the key key, final V the value to be added. value) Implements jakarta.ws.rs.core.MultivaluedMap.add. Add a value to the current list of values for the supplied key.
public final void	addAll(final K the key. key, final V... the values to be added. newValues) Implements jakarta.ws.rs.core.MultivaluedMap.addAll. Add multiple values to the current list of values for the supplied key.
public final void	addAll(final K the key. key, final List<V> the list of values to be added. valueList) Implements jakarta.ws.rs.core.MultivaluedMap.addAll. Add all the values from the supplied value list to the current list of values for the supplied key.
public final void	addFirst(final K the key key, final V the value to be added. value) Implements jakarta.ws.rs.core.MultivaluedMap.addFirst. Add a value to the first position in the current list of values for the supplied key.
protected void	addFirstNull(final List<V> value list where the `null` value addition is being requested. values) Define the behavior for adding a `null` values to the first position in the value list.
protected void	addNull(final List<V> value list where the `null` value addition is being requested. values) Define the behavior for adding a `null` values to the value list.
public void	clear() Implements java.util.Map.clear. Removes all of the mappings from this map (optional operation).
public boolean	containsKey(final Object key whose presence in this map is to be tested key) Implements java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key.
public boolean	containsValue(final Object value whose presence in this map is to be tested value) Implements java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value.
public Set<Map.Entry<K, List<V>>>	entrySet() Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.
public boolean	Returns: `true` if the specified object is equal to the underlying [key, multi-value] store, `false` otherwise. equals(final Object object to be compared for equality with this map o) Overrides java.lang.Object.equals. Implements java.util.Map.equals. Compares the specified object with this map for equality.
public boolean	equalsIgnoreValueOrder(final MultivaluedMap<K, V> map to be compared to this one. omap) Implements jakarta.ws.rs.core.MultivaluedMap.equalsIgnoreValueOrder. Compare the specified map with this map for equality modulo the order of values for each key.
public List<V>	get(final Object the key whose associated value is to be returned key) Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
public final V	getFirst(final K the key key) Implements jakarta.ws.rs.core.MultivaluedMap.getFirst. A shortcut to get the first value of the supplied key.
protected final List<V>	Returns: value list registered with the key. The method is guaranteed to never return `null`. getValues(final K the key. key) Return a non-null list of values for a given key.
public int	Returns: a hash code value for the underlying [key, multi-value] store. hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.hashCode. Returns the hash code value for this map.
public boolean	isEmpty() Implements java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.
public Set<K>	keySet() Implements java.util.Map.keySet. Returns a `Set` view of the keys contained in this map.
public List<V>	put(final K key with which the specified value is to be associated key, final List<V> value to be associated with the specified key value) Implements java.util.Map.put. Associates the specified value with the specified key in this map (optional operation).
public void	putAll(final Map<? extends K, ? extends List<V>> mappings to be stored in this map m) Implements java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation).
public final void	putSingle(final K the key key, final V the single value of the key. If the value is `null` it will be ignored. value) Implements jakarta.ws.rs.core.MultivaluedMap.putSingle. Set the value for the key to be a one item list consisting of the supplied value.
public List<V>	remove(final Object key whose mapping is to be removed from the map key) Implements java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation).
public int	size() Implements java.util.Map.size. Returns the number of key-value mappings in this map.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Collection<List<V>>	values() Implements java.util.Map.values. Returns a `Collection` view of the values contained in this map.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

store	back to summary
protected final Map<K, List<V>> store Backing store for the [key, multi-value] pairs.

AbstractMultivaluedMap	back to summary
public AbstractMultivaluedMap(final Map<K, List<V>> store) Initialize the backing store in the abstract parent multivalued map implementation. Parameters store:Map<K, List<V>> the backing `Map` to be used as a [key, multi-value] store. Must not be `null`. Exceptions NullPointerException: in case the underlying `store` parameter is `null`.

Method Detail

add back to summary

add	back to summary
public final void add(final K key, final V value) Implements jakarta.ws.rs.core.MultivaluedMap.add. Add a value to the current list of values for the supplied key. NOTE: This implementation ignores `null` values; A supplied value of `null` is ignored and not added to the value list. Overriding implementations may modify this behavior by redefining the `addNull(java.util.List)` method. Parameters key:K the key value:V the value to be added. Annotations @Override

public final void add(final K key, final V value)

Implements jakarta.ws.rs.core.MultivaluedMap.add.

Add a value to the current list of values for the supplied key.

NOTE: This implementation ignores null values; A supplied value of null is ignored and not added to the value list. Overriding implementations may modify this behavior by redefining the addNull(java.util.List) method.

Parameters

key:K: the key
value:V: the value to be added.

Annotations

@Override

addAll back to summary

addAll	back to summary
public final void addAll(final K key, final V... newValues) Implements jakarta.ws.rs.core.MultivaluedMap.addAll. 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 `NullPointerException` if the supplied array of values is `null`. NOTE: This implementation ignores `null` values; Any of the supplied values of `null` is ignored and not added to the value list. Overriding implementations may modify this behavior by redefining the `addNull(java.util.List)` method. Parameters key:K the key. newValues:V[] the values to be added. Annotations @Override Exceptions NullPointerException: if the supplied array of new values is `null`.

public final void addAll(final K key, final V... newValues)

Implements jakarta.ws.rs.core.MultivaluedMap.addAll.

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 NullPointerException if the supplied array of values is null.

NOTE: This implementation ignores null values; Any of the supplied values of null is ignored and not added to the value list. Overriding implementations may modify this behavior by redefining the addNull(java.util.List) method.

Parameters

key:K: the key.
newValues:V[]: the values to be added.

Annotations

@Override

Exceptions

NullPointerException:: if the supplied array of new values is null.

addAll back to summary

addAll	back to summary
public final void addAll(final K key, final List<V> valueList) Implements jakarta.ws.rs.core.MultivaluedMap.addAll. 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 `NullPointerException` if the supplied array of values is `null`. NOTE: This implementation ignores `null` values; Any `null` value in the supplied value list is ignored and not added to the value list. Overriding implementations may modify this behavior by redefining the `addNull(java.util.List)` method. Parameters key:K the key. valueList:List<V> the list of values to be added. Annotations @Override Exceptions NullPointerException: if the supplied value list is `null`.

public final void addAll(final K key, final List<V> valueList)

Implements jakarta.ws.rs.core.MultivaluedMap.addAll.

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 NullPointerException if the supplied array of values is null.

NOTE: This implementation ignores null values; Any null value in the supplied value list is ignored and not added to the value list. Overriding implementations may modify this behavior by redefining the addNull(java.util.List) method.

Parameters

key:K: the key.
valueList:List<V>: the list of values to be added.

Annotations

@Override

Exceptions

NullPointerException:: if the supplied value list is null.

addFirst back to summary

addFirst	back to summary
public final void addFirst(final K key, final V value) Implements jakarta.ws.rs.core.MultivaluedMap.addFirst. Add a value to the first position in the current list of values for the supplied key. NOTE: This implementation ignores `null` values; A supplied value of `null` is ignored and not added to the purged value list. Overriding implementations may modify this behavior by redefining the `addFirstNull(java.util.List)` method. Parameters key:K the key value:V the value to be added. Annotations @Override

public final void addFirst(final K key, final V value)

Implements jakarta.ws.rs.core.MultivaluedMap.addFirst.

Add a value to the first position in the current list of values for the supplied key.

NOTE: This implementation ignores null values; A supplied value of null is ignored and not added to the purged value list. Overriding implementations may modify this behavior by redefining the addFirstNull(java.util.List) method.

Parameters

key:K: the key
value:V: the value to be added.

Annotations

@Override

addFirstNull back to summary

addFirstNull	back to summary
protected void addFirstNull(final List<V> values) Define the behavior for adding a `null` values to the first position in the value list. Default implementation is a no-op, i.e. the `null` values are ignored. Overriding implementations may modify this behavior by providing their own definitions of this method. Parameters values:List<V> value list where the `null` value addition is being requested. Annotations @SuppressWarnings:UnusedParameters

protected void addFirstNull(final List<V> values)

Define the behavior for adding a null values to the first position in the value list.

Default implementation is a no-op, i.e. the null values are ignored. Overriding implementations may modify this behavior by providing their own definitions of this method.

Parameters

values:List<V>: value list where the null value addition is being requested.

Annotations

@SuppressWarnings:UnusedParameters

addNull back to summary

addNull	back to summary
protected void addNull(final List<V> values) Define the behavior for adding a `null` values to the value list. Default implementation is a no-op, i.e. the `null` values are ignored. Overriding implementations may modify this behavior by providing their own definitions of this method. Parameters values:List<V> value list where the `null` value addition is being requested. Annotations @SuppressWarnings:UnusedParameters

protected void addNull(final List<V> values)

Define the behavior for adding a null values to the value list.

Default implementation is a no-op, i.e. the null values are ignored. Overriding implementations may modify this behavior by providing their own definitions of this method.

Parameters

values:List<V>: value list where the null value addition is being requested.

Annotations

@SuppressWarnings:UnusedParameters

clear	back to summary
public void clear() Implements java.util.Map.clear. Doc from java.util.Map.clear. Removes all of the mappings from this map (optional operation). The map will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Annotations

@Override

containsKey back to summary

containsKey	back to summary
public boolean containsKey(final Object key) Implements java.util.Map.containsKey. Doc from java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key. More formally, returns `true` if and only if this map contains a mapping for a key `k` such that `Objects.equals(key, k)`. (There can be at most one such mapping.) Parameters key:Object key whose presence in this map is to be tested Returns:boolean `true` if this map contains a mapping for the specified key Annotations @Override

public boolean containsKey(final Object key)

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters

key:Object: key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

Annotations

@Override

containsValue back to summary

containsValue	back to summary
public boolean containsValue(final Object value) Implements java.util.Map.containsValue. Doc from java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value. More formally, returns `true` if and only if this map contains at least one mapping to a value `v` such that `Objects.equals(value, v)`. This operation will probably require time linear in the map size for most implementations of the `Map` interface. Parameters value:Object value whose presence in this map is to be tested Returns:boolean `true` if this map maps one or more keys to the specified value Annotations @Override

public boolean containsValue(final Object value)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters

value:Object: value whose presence in this map is to be tested

Returns:boolean

true if this map maps one or more keys to the specified value

Annotations

@Override

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<K, List<V>>> entrySet() Implements java.util.Map.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation, or through the `setValue` operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<Map.Entry<K, List<V>>> a set view of the mappings contained in this map Annotations @Override

public Set<Map.Entry<K, List<V>>> entrySet()

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<Map.Entry<K, List<V>>>

a set view of the mappings contained in this map

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Implements java.util.Map.equals. Doc from java.util.Map.equals. Compares the specified object with this map for equality. Returns `true` if the given object is also a map and the two maps represent the same mappings. More formally, two maps `m1` and `m2` represent the same mappings if `m1.entrySet().equals(m2.entrySet())`. This ensures that the `equals` method works properly across different implementations of the `Map` interface. This implementation delegates the method call to to the the underlying [key, multi-value] store. Parameters o:Object object to be compared for equality with this map Returns:boolean `true` if the specified object is equal to the underlying [key, multi-value] store, `false` otherwise. Annotations @Override @SuppressWarnings:EqualsWhichDoesntCheckParameterClass

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Implements java.util.Map.equals.

Doc from java.util.Map.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

This implementation delegates the method call to to the the underlying [key, multi-value] store.

Parameters

o:Object: object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to the underlying [key, multi-value] store, false otherwise.

Annotations

@Override
@SuppressWarnings:EqualsWhichDoesntCheckParameterClass

equalsIgnoreValueOrder	back to summary
public boolean equalsIgnoreValueOrder(final MultivaluedMap<K, V> omap) Implements jakarta.ws.rs.core.MultivaluedMap.equalsIgnoreValueOrder. Doc from jakarta.ws.rs.core.MultivaluedMap.equalsIgnoreValueOrder. 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. Parameters omap:MultivaluedMap<K, V> map to be compared to this one. Returns:boolean true if the maps are equal modulo value ordering. Annotations @Override

equalsIgnoreValueOrder

back to summary

public boolean equalsIgnoreValueOrder(final MultivaluedMap<K, V> omap)

Implements jakarta.ws.rs.core.MultivaluedMap.equalsIgnoreValueOrder.

Doc from jakarta.ws.rs.core.MultivaluedMap.equalsIgnoreValueOrder.

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.

Parameters

omap:MultivaluedMap<K, V>: map to be compared to this one.

Returns:boolean

true if the maps are equal modulo value ordering.

Annotations

@Override

get back to summary

get	back to summary
public List<V> get(final Object key) Implements java.util.Map.get. Doc from java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `Objects.equals(key, k)`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) If this map permits null values, then a return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object the key whose associated value is to be returned Returns:List<V> the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override

public List<V> get(final Object key)

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object: the key whose associated value is to be returned

Returns:List<V>

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override

getFirst	back to summary
public final V getFirst(final K key) Implements jakarta.ws.rs.core.MultivaluedMap.getFirst. Doc from jakarta.ws.rs.core.MultivaluedMap.getFirst. A shortcut to get the first value of the supplied key. Parameters key:K the key Returns:V the first value for the specified key or null if the key is not in the map. Annotations @Override

getFirst

back to summary

public final V getFirst(final K key)

Implements jakarta.ws.rs.core.MultivaluedMap.getFirst.

Doc from jakarta.ws.rs.core.MultivaluedMap.getFirst.

A shortcut to get the first value of the supplied key.

Parameters

key:K: the key

Returns:V

the first value for the specified key or null if the key is not in the map.

Annotations

@Override

getValues back to summary

getValues	back to summary
protected final List<V> getValues(final 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 empty `List` instance is created, registered within the map to hold the values of the key and returned from the method. Parameters key:K the key. Returns:List<V> value list registered with the key. The method is guaranteed to never return `null`.

protected final List<V> getValues(final 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 empty List instance is created, registered within the map to hold the values of the key and returned from the method.

Parameters

key:K: the key.

Returns:List<V>

value list registered with the key. The method is guaranteed to never return null.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.hashCode. Doc from java.util.Map.hashCode. Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's `entrySet()` view. This ensures that `m1.equals(m2)` implies that `m1.hashCode()==m2.hashCode()` for any two maps `m1` and `m2`, as required by the general contract of `Object#hashCode`. This implementation delegates the method call to to the the underlying [key, multi-value] store. Returns:int a hash code value for the underlying [key, multi-value] store. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.hashCode.

Doc from java.util.Map.hashCode.

Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object#hashCode.

This implementation delegates the method call to to the the underlying [key, multi-value] store.

Returns:int

a hash code value for the underlying [key, multi-value] store.

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Map.isEmpty. Doc from java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings. Returns:boolean `true` if this map contains no key-value mappings Annotations @Override

public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean

true if this map contains no key-value mappings

Annotations

@Override

keySet back to summary

keySet	back to summary
public Set<K> keySet() Implements java.util.Map.keySet. Doc from java.util.Map.keySet. Returns a `Set` view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll`, and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<K> a set view of the keys contained in this map Annotations @Override

public Set<K> keySet()

Implements java.util.Map.keySet.

Doc from java.util.Map.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<K>

a set view of the keys contained in this map

Annotations

@Override

put back to summary

put	back to summary
public List<V> put(final K key, final List<V> value) Implements java.util.Map.put. Doc from java.util.Map.put. Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map `m` is said to contain a mapping for a key `k` if and only if `m.containsKey(k)` would return `true`.) Parameters key:K key with which the specified value is to be associated value:List<V> value to be associated with the specified key Returns:List<V> the previous value associated with `key`, or `null` if there was no mapping for `key`. (A `null` return can also indicate that the map previously associated `null` with `key`, if the implementation supports `null` values.) Annotations @Override

public List<V> put(final K key, final List<V> value)

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters

key:K: key with which the specified value is to be associated
value:List<V>: value to be associated with the specified key

Returns:List<V>

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Annotations

@Override

putAll back to summary

putAll	back to summary
public void putAll(final Map<? extends K, ? extends List<V>> m) Implements java.util.Map.putAll. Doc from java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling `put(k, v)` on this map once for each mapping from key `k` to value `v` in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order. Parameters m:Map<? extends K, ? extends List<V>> mappings to be stored in this map Annotations @Override

public void putAll(final Map<? extends K, ? extends List<V>> m)

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters

m:Map<? extends K, ? extends List<V>>: mappings to be stored in this map

Annotations

@Override

putSingle back to summary

putSingle	back to summary
public final void putSingle(final K key, final V value) Implements jakarta.ws.rs.core.MultivaluedMap.putSingle. 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 ignores `null` values; A supplied value of `null` 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 the `addNull(java.util.List)` method. Parameters key:K the key value:V the single value of the key. If the value is `null` it will be ignored. Annotations @Override

public final void putSingle(final K key, final V value)

Implements jakarta.ws.rs.core.MultivaluedMap.putSingle.

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 ignores null values; A supplied value of null 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 the addNull(java.util.List) method.

Parameters

key:K: the key
value:V: the single value of the key. If the value is null it will be ignored.

Annotations

@Override

remove back to summary

remove	back to summary
public List<V> remove(final Object key) Implements java.util.Map.remove. Doc from java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key `k` to value `v` such that `Objects.equals(key, k)`, that mapping is removed. (The map can contain at most one such mapping.) Returns the value to which this map previously associated the key, or `null` if the map contained no mapping for the key. If this map permits null values, then a return value of `null` does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to `null`. The map will not contain a mapping for the specified key once the call returns. Parameters key:Object key whose mapping is to be removed from the map Returns:List<V> the previous value associated with `key`, or `null` if there was no mapping for `key`. Annotations @Override

public List<V> remove(final Object key)

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters

key:Object: key whose mapping is to be removed from the map

Returns:List<V>

the previous value associated with key, or null if there was no mapping for key.

Annotations

@Override

size back to summary

size	back to summary
public int size() Implements java.util.Map.size. Doc from java.util.Map.size. Returns the number of key-value mappings in this map. If the map contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of key-value mappings in this map Annotations @Override

public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of key-value mappings in this map

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

values back to summary

values	back to summary
public Collection<List<V>> values() Implements java.util.Map.values. Doc from java.util.Map.values. Returns a `Collection` view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own `remove` operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Collection.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Collection<List<V>> a collection view of the values contained in this map Annotations @Override

public Collection<List<V>> values()

Implements java.util.Map.values.

Doc from java.util.Map.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<List<V>>

a collection view of the values contained in this map

Annotations

@Override

public abstract Class AbstractMultivaluedMap<K, V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail