Package org.glassfish.jersey.internal.util.collection

Class GuardianStringKeyMultivaluedMap<V>

java.lang.Object

org.glassfish.jersey.internal.util.collection.GuardianStringKeyMultivaluedMap<V>

Type Parameters:

V - The value type of the wrapped MultivaluedMap.

All Implemented Interfaces:

MultivaluedMap<String,V>, Map<String,List<V>>

public class GuardianStringKeyMultivaluedMap<V>
extends Object
implements MultivaluedMap<String,V>

The MultivaluedMap wrapper that is able to set guards observing changes of values represented by a key.

Since:

2.38

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
GuardianStringKeyMultivaluedMap(MultivaluedMap<String,V> inner)

Method Summary

Modifier and Type	Method	Description
void	add(String key, V value)	Add a value to the current list of values for the supplied key.
void	addAll(String 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(String key, V... newValues)	Add multiple values to the current list of values for the supplied key.
void	addFirst(String key, V value)	Add a value to the first position in the current list of values for the supplied key.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,List<V>>>	entrySet()
boolean	equals(Object o)
boolean	equalsIgnoreValueOrder(MultivaluedMap<String,V> otherMap)	Compare the specified map with this map for equality modulo the order of values for each key.
List<V>	get(Object key)
V	getFirst(String key)	A shortcut to get the first value of the supplied key.
Set<String>	getGuards()	Get all the guarded keys
int	hashCode()
boolean	isEmpty()
boolean	isObservedAndReset(String key)	Return true when the value represented by the key has changed.
Set<String>	keySet()
List<V>	put(String key, List<V> value)
void	putAll(Map<? extends String,? extends List<V>> m)
void	putSingle(String key, V value)	Set the key's value to be a one item list consisting of the supplied value.
List<V>	remove(Object key)
void	setGuard(String key)	Observe changes of a value represented by the 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

GuardianStringKeyMultivaluedMap

public GuardianStringKeyMultivaluedMap(MultivaluedMap<String,V> inner)

Method Detail

putSingle

public void putSingle(String key,
                      V value)

Description copied from interface: MultivaluedMap

Set the key's value to be a one item list consisting of the supplied value. Any existing values will be replaced.

Specified by:

putSingle in interface MultivaluedMap<String,V>

Parameters:

key - the key

value - the single value of the key

add

public void add(String key,
                V value)

Description copied from interface: MultivaluedMap

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

Specified by:

add in interface MultivaluedMap<String,V>

Parameters:

key - the key

value - the value to be added.

getFirst

public V getFirst(String key)

Description copied from interface: MultivaluedMap

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

Specified by:

getFirst in interface MultivaluedMap<String,V>

Parameters:

key - the key

Returns:

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

addAll

public void addAll(String key,
                   V... newValues)

Description copied from interface: MultivaluedMap

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.

Specified by:

addAll in interface MultivaluedMap<String,V>

Parameters:

key - the key.

newValues - the values to be added.

addAll

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

Description copied from interface: MultivaluedMap

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.

Specified by:

addAll in interface MultivaluedMap<String,V>

Parameters:

key - the key.

valueList - the list of values to be added.

addFirst

public void addFirst(String key,
                     V value)

Description copied from interface: MultivaluedMap

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

Specified by:

addFirst in interface MultivaluedMap<String,V>

Parameters:

key - the key

value - the value to be added.

equalsIgnoreValueOrder

public boolean equalsIgnoreValueOrder(MultivaluedMap<String,V> otherMap)

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 interface MultivaluedMap<String,V>

Parameters:

otherMap - map to be compared to this one.

Returns:

true if the maps are equal modulo value ordering.

size

public int size()

Specified by:

size in interface Map<String,List<V>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,List<V>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,List<V>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,List<V>>

get

public List<V> get(Object key)

Specified by:

get in interface Map<String,List<V>>

put

public List<V> put(String key,
                   List<V> value)

Specified by:

put in interface Map<String,List<V>>

remove

public List<V> remove(Object key)

Specified by:

remove in interface Map<String,List<V>>

putAll

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

Specified by:

putAll in interface Map<String,List<V>>

clear

public void clear()

Specified by:

clear in interface Map<String,List<V>>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,List<V>>

values

public Collection<List<V>> values()

Specified by:

values in interface Map<String,List<V>>

entrySet

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

Specified by:

entrySet in interface Map<String,List<V>>

setGuard

public void setGuard(String key)

Observe changes of a value represented by the key.

Parameters:

key - the key values to observe

getGuards

public Set<String> getGuards()

Get all the guarded keys

Returns:

a Set of keys guarded.

isObservedAndReset

public boolean isObservedAndReset(String key)

Return true when the value represented by the key has changed. Resets any observation - the operation is not idempotent.

Parameters:

key - the Key observed.

Returns:

whether the value represented by the key has changed.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,List<V>>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,List<V>>

Overrides:

hashCode in class Object