org.glassfish.jersey.internal.util.collection
Class ImmutableMultivaluedMap<K,V>

java.lang.Object
  org.glassfish.jersey.internal.util.collection.ImmutableMultivaluedMap<K,V>

Type Parameters:

K - the key

V - the value

All Implemented Interfaces:

Map<K,List<V>>, MultivaluedMap<K,V>

public class ImmutableMultivaluedMap<K,V>
extends Object
implements MultivaluedMap<K,V>

An immutable view of a MultivaluedMap.

Author:

Gili Tzabari, Michal Gajdos (michal.gajdos at oracle.com)

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

ImmutableMultivaluedMap(MultivaluedMap<K,V> delegate)
Creates a new ImmutableMultivaluedMap.

Method Summary

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.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
static <K,V> ImmutableMultivaluedMap<K,V>	empty() Returns an empty immutable map.
Set<Map.Entry<K,List<V>>>	entrySet()
boolean	equalsIgnoreValueOrder(MultivaluedMap<K,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(K key) A shortcut to get the first value of the supplied key.
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 key's value to be a one item list consisting of the supplied value.
List<V>	remove(Object key)
int	size()
Collection<List<V>>	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

equals, hashCode

Constructor Detail

ImmutableMultivaluedMap

public ImmutableMultivaluedMap(MultivaluedMap<K,V> delegate)

Creates a new ImmutableMultivaluedMap.

Parameters:

delegate - the underlying MultivaluedMap

Method Detail

empty

public static <K,V> ImmutableMultivaluedMap<K,V> empty()

Returns an empty immutable map.

Returns:

an empty immutable map.

equalsIgnoreValueOrder

public boolean equalsIgnoreValueOrder(MultivaluedMap<K,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<K,V>

Parameters:

otherMap - map to be compared to this one.

Returns:

true if the maps are equal modulo value ordering.

putSingle

public void putSingle(K 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<K,V>

Parameters:

key - the key

value - the single value of the key

add

public void add(K 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<K,V>

Parameters:

key - the key

value - the value to be added.

getFirst

public V getFirst(K key)

Description copied from interface: MultivaluedMap

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

Specified by:

getFirst in interface MultivaluedMap<K,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(K 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<K,V>

Parameters:

key - the key.

newValues - the values to be added.

addAll

public void addAll(K 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<K,V>

Parameters:

key - the key.

valueList - the list of values to be added.

addFirst

public void addFirst(K 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<K,V>

Parameters:

key - the key

value - the value to be added.

size

public int size()

Specified by:

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

isEmpty

public boolean isEmpty()

Specified by:

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

containsKey

public boolean containsKey(Object key)

Specified by:

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

containsValue

public boolean containsValue(Object value)

Specified by:

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

get

public List<V> get(Object key)

Specified by:

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

put

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

Specified by:

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

remove

public List<V> remove(Object key)

Specified by:

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

putAll

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

Specified by:

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

clear

public void clear()

Specified by:

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

keySet

public Set<K> keySet()

Specified by:

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

values

public Collection<List<V>> values()

Specified by:

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

entrySet

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

Specified by:

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