public final class UriParameterMap extends com.google.common.collect.ForwardingMultimap<String,String> implements com.google.common.collect.ListMultimap<String,String>, Cloneable, Serializable
This class stores keys and values in unicode (decoded) form, allowing
clients to get and set parameters safely using normal strings. Encoding is
performed when toString(Charset) is called. See the UriEncoder class comments for an important discussion regarding encoding.
Parameter maps may not contain null values. Both keys and values are
allowed to be the empty string, though in most cases only values are the
empty string. Parsing a query string may be a "lossy" operation in the
trivial sense, in that the original string cannot be exactly reconstructed;
for example, the query string "foo=&bar" is considered equivalent to
"foo&bar". Also note that parsing the empty string will not return an
empty map but will return a map with a single entry of the empty string as
both key and value. The empty map (see EMPTY_MAP) represents an
undefined query.
In addition to the ListMultimap API, this class provides a
convenient getFirst(java.lang.String) method for retrieving the first value of a
parameter, for when you expect only a single parameter of the specified name.
Parameter maps are typically constructed either by Uri or UriBuilder. However, you may also construct a parameter map from scratch
using the constructor, or by calling parse(String).
UriBuilder#getQueryParameters(),
Uri#getQueryParameters(),
Serialized Form| Modifier and Type | Field and Description |
|---|---|
static UriParameterMap |
EMPTY_MAP
The immutable empty map.
|
| Constructor and Description |
|---|
UriParameterMap()
Constructs a new empty parameter map.
|
| Modifier and Type | Method and Description |
|---|---|
void |
appendTo(Appendable out,
Charset encoding)
Appends the string representation of these parameters to the specified
Appendable using the specified encoding. |
void |
appendTo(StringBuilder out,
Charset encoding)
Appends the string representation of these parameters to the specified
string builder using the specified encoding.
|
UriParameterMap |
clone() |
Map<String,String[]> |
copyToArrayMap()
Returns an immutable copy of this parameter map as a
Map from
strings to string arrays. |
protected com.google.common.collect.ListMultimap<String,String> |
delegate() |
List<String> |
get(String key) |
String |
getFirst(String key)
Returns the first parameter value for the specified
key (parameter
name) or null if no parameters are defined for that key. |
static UriParameterMap |
parse(String query)
Constructs a new parameter map populated with parameters parsed from the
specified query string using the
UriEncoder.DEFAULT_ENCODING,
UTF-8. |
static UriParameterMap |
parse(String query,
Charset encoding)
Constructs a new parameter map populated with parameters parsed from the
specified query string using the specified encoding.
|
List<String> |
removeAll(Object key) |
List<String> |
replaceValues(String key,
Iterable<? extends String> values) |
String |
toString()
Returns the string representation of these parameters using the
UriEncoder.DEFAULT_ENCODING, UTF-8, e.g., "q=flowers&n=20". |
String |
toString(Charset encoding)
Returns the string representation of these parameters using the specified
encoding, e.g., "q=flowers&n=20".
|
static UriParameterMap |
unmodifiableMap(UriParameterMap map)
Returns an unmodifiable view of the specified parameter map.
|
asMap, clear, containsEntry, containsKey, containsValue, entries, equals, hashCode, isEmpty, keys, keySet, put, putAll, putAll, remove, size, valuespublic static final UriParameterMap EMPTY_MAP
public static UriParameterMap parse(String query)
UriEncoder.DEFAULT_ENCODING,
UTF-8.query - the query string, e.g., "q=flowers&n=20"NullPointerException - if query is nullpublic static UriParameterMap parse(String query, Charset encoding)
query - the query string, e.g., "q=flowers&n=20"encoding - the character encoding to useNullPointerException - if any argument is nullpublic static UriParameterMap unmodifiableMap(UriParameterMap map)
UnsupportedOperationException.map - the parameter map for which to return an unmodifiable viewNullPointerException - if map is nullpublic String getFirst(String key)
key (parameter
name) or null if no parameters are defined for that key. If the
parameter is defined, equivalent to get(key).get(0).key - the name of the parameterjavax.servlet.ServletRequest#getParameter(String)public void appendTo(StringBuilder out, Charset encoding)
out - the string builder to append toencoding - the character encoding to useNullPointerException - if any argument is nullpublic void appendTo(Appendable out, Charset encoding) throws IOException
Appendable using the specified encoding.out - the appendable to append toencoding - the character encoding to useNullPointerException - if any argument is nullIOException - if the Appendable encounters an errorpublic UriParameterMap clone()
public String toString(Charset encoding)
encoding - the character encoding to useNullPointerException - if encoding is nullpublic Map<String,String[]> copyToArrayMap()
Map from
strings to string arrays.public String toString()
UriEncoder.DEFAULT_ENCODING, UTF-8, e.g., "q=flowers&n=20".toString in class com.google.common.collect.ForwardingObjectCopyright © 2012. All Rights Reserved.