com.communote.plugins.api.rest.resource

Class RestApiMultivaluedMapWrapper<T>

java.lang.Object

com.communote.plugins.api.rest.resource.RestApiMultivaluedMapWrapper<T>

Type Parameters:

T - type of the value

All Implemented Interfaces:

Map<String,T>

public class RestApiMultivaluedMapWrapper<T>
extends Object
implements Map<String,T>

Wraps a MultivaluedMap so that by default the first entry will be returned at get. However the wrapper can be configured to join parameters by "," if the parameters name is defined in commaSeparatedParameters (as passed to the constructor). For example if the values "f_userIds" is set in the commaSeparatedParameters list then get() will join all values of the multivalued map. If the multivalued map contains two value "1,2" and "45" then the result will be "1,2,45"

Author:

Communote GmbH - http://www.communote.com/

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RestApiMultivaluedMapWrapper(javax.ws.rs.core.MultivaluedMap<String,String> multivaluedMap)
RestApiMultivaluedMapWrapper(javax.ws.rs.core.MultivaluedMap<String,String> multivaluedMap, Collection<String> commaSeparatedParameters)

Method Summary

Modifier and Type	Method and Description
void	clear() Calls multivaluedMap.clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,T>>	entrySet() Not supported.
T	get(Object key) If the wrapped multivalued map contains several values and the key is defined in commaSeparatedParameters (as passed to the constructor) then all values are joined by ","
boolean	isEmpty()
Set<String>	keySet()
String	put(String key, String value) Calls multivaluedMap.putSingle(key, value)
T	put(String key, T value) Calls multivaluedMap.putSingle(key, value) type of the value
void	putAll(Map<? extends String,? extends T> m) Calls multivaluedMap.putSingle(key, value) type of the value
T	remove(Object key)
int	size()
Collection<T>	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

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

RestApiMultivaluedMapWrapper

public RestApiMultivaluedMapWrapper(javax.ws.rs.core.MultivaluedMap<String,String> multivaluedMap)

Parameters:

multivaluedMap - The map to wrap.

RestApiMultivaluedMapWrapper

public RestApiMultivaluedMapWrapper(javax.ws.rs.core.MultivaluedMap<String,String> multivaluedMap,
                                    Collection<String> commaSeparatedParameters)

Parameters:

multivaluedMap - The map to wrap.

commaSeparatedParameters - commaSeparatedParameters (as passed to the constructor) then all values are joined by ","

Method Detail

clear

public void clear()

Calls multivaluedMap.clear()

Specified by:

clear in interface Map<String,T>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,T>

Returns:

multivaluedMap.containsKey(key)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,T>

Returns:

multivaluedMap.containsValue(value)

entrySet

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

Not supported. Throws an UnsupportedOperationException.

Specified by:

entrySet in interface Map<String,T>

Returns:

Nothing.

get

public T get(Object key)

If the wrapped multivalued map contains several values and the key is defined in commaSeparatedParameters (as passed to the constructor) then all values are joined by ","

Specified by:

get in interface Map<String,T>

Parameters:

key - The key.

Returns:

multivaluedMap#getFirst(key)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,T>

Returns:

multivaluedMap.isEmpty()

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,T>

Returns:

multivaluedMap.keySet()

put

public String put(String key,
                  String value)

Calls multivaluedMap.putSingle(key, value)

Parameters:

key - The key.

value - The value

Returns:

The first value, if there is one.

put

public T put(String key,
             T value)

Calls multivaluedMap.putSingle(key, value) type of the value

Specified by:

put in interface Map<String,T>

Parameters:

key - The key.

value - The value

Returns:

value of MultivaluedMap

putAll

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

Calls multivaluedMap.putSingle(key, value) type of the value

Specified by:

putAll in interface Map<String,T>

Parameters:

m - map of the same object

remove

public T remove(Object key)

Specified by:

remove in interface Map<String,T>

Returns:

Removes all elements, but returns the first one.

size

public int size()

Specified by:

size in interface Map<String,T>

Returns:

multivaluedMap.size()

values

public Collection<T> values()

Specified by:

values in interface Map<String,T>

Returns:

Returns a list of the first values.