org.springframework.social.support

Class ParameterMap

java.lang.Object

org.springframework.social.support.ParameterMap

All Implemented Interfaces:

Map<String,List<String>>, MultiValueMap<String,String>

Direct Known Subclasses:

OAuth1Parameters, OAuth2Parameters

public class ParameterMap
extends Object
implements MultiValueMap<String,String>

Generally useful base class for creating MultiValueMaps that store HTTP query parameters. May be subclassed to add specific getter/setter methods for known parameters used in a specific context. Also makes it easy to adapt a Map<String, List<String>> to an MultiValueMap<String, String>.

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParameterMap() Creates a new MultiValueMap<String, String> that is initially empty.
protected	ParameterMap(Map<String,List<String>> parameters) Wraps the provided Map<String, List<String>> as a MultiValueMap<String, String>.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String key, String value)
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,List<String>>>	entrySet()
List<String>	get(Object key)
String	getFirst(String key)
boolean	isEmpty()
Set<String>	keySet()
List<String>	put(String key, List<String> values)
void	putAll(Map<? extends String,? extends List<String>> map)
List<String>	remove(Object key)
void	set(String key, String value)
void	setAll(Map<String,String> values)
int	size()
Map<String,String>	toSingleValueMap()
Collection<List<String>>	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

ParameterMap

protected ParameterMap()

Creates a new MultiValueMap<String, String> that is initially empty.

ParameterMap

protected ParameterMap(Map<String,List<String>> parameters)

Wraps the provided Map<String, List<String>> as a MultiValueMap<String, String>. The map passed in is stored internally. No copy is created

Parameters:

parameters - the parameters as a Map.

Method Detail

clear

public void clear()

Specified by:

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

containsKey

public boolean containsKey(Object key)

Specified by:

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

containsValue

public boolean containsValue(Object value)

Specified by:

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

entrySet

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

Specified by:

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

get

public List<String> get(Object key)

Specified by:

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

isEmpty

public boolean isEmpty()

Specified by:

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

keySet

public Set<String> keySet()

Specified by:

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

put

public List<String> put(String key,
               List<String> values)

Specified by:

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

putAll

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

Specified by:

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

remove

public List<String> remove(Object key)

Specified by:

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

size

public int size()

Specified by:

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

values

public Collection<List<String>> values()

Specified by:

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

getFirst

public String getFirst(String key)

Specified by:

getFirst in interface MultiValueMap<String,String>

add

public void add(String key,
       String value)

Specified by:

add in interface MultiValueMap<String,String>

set

public void set(String key,
       String value)

Specified by:

set in interface MultiValueMap<String,String>

setAll

public void setAll(Map<String,String> values)

Specified by:

setAll in interface MultiValueMap<String,String>

toSingleValueMap

public Map<String,String> toSingleValueMap()

Specified by:

toSingleValueMap in interface MultiValueMap<String,String>