Module com.aoapps.net.types

Package com.aoapps.net

Class URIParametersMap

java.lang.Object

com.aoapps.net.URIParametersMap

All Implemented Interfaces:

Writable, MutableURIParameters, URIParameters

public class URIParametersMap
extends Object
implements MutableURIParameters

A modifiable parameter map.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
URIParametersMap()	Creates an empty set of parameters.
URIParametersMap(String queryString)	Parses the provided URL-Encoded parameter string.

Method Summary

Modifier and Type	Method	Description
URIParametersMap	add(String name, Iterable<?> values)	Adds a parameter with multiple values.
URIParametersMap	add(String name, Object value)	Adds a parameter with a single value.
URIParametersMap	add(String name, Object... values)	Adds a parameter with multiple values.
final URIParametersMap	add(String name, String value)	Adds a parameter with a single value.
String	getParameter(String name)	Gets the value for the provided parameter name or null if doesn't exist.
Map<String,List<String>>	getParameterMap()	Gets an unmodifiable map view of all parameters.
Iterator<String>	getParameterNames()	Gets an unmodifiable iterator of the parameter names.
List<String>	getParameterValues(String name)	Gets an unmodifiable view of all values for a multi-value parameter or null if has no values.
boolean	isFastToString()
static URIParametersMap	of()
static URIParametersMap	of(String name, Object value)
static URIParametersMap	of(String name1, Object value1, String name2, Object value2)
static URIParametersMap	of(String name1, Object value1, String name2, Object value2, String name3, Object value3)
static URIParametersMap	of(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4)
static URIParametersMap	of(String name1, Object value1, String name2, Object value2, String name3, Object value3, String name4, Object value4, String name5, Object value5)
static URIParametersMap	of(String name, String value)
static URIParametersMap	of(String name1, String value1, String name2, String value2)
static URIParametersMap	of(String name1, String value1, String name2, String value2, String name3, String value3)
static URIParametersMap	of(String name1, String value1, String name2, String value2, String name3, String value3, String name4, String value4)
static URIParametersMap	of(String name1, String value1, String name2, String value2, String name3, String value3, String name4, String value4, String name5, String value5)
String	toString()	Gets the query string encoded in the default encoding IRI.ENCODING, not including the '?'

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.aoapps.net.MutableURIParameters

addParameter, addParameters

Methods inherited from interface com.aoapps.net.URIParameters

appendTo, appendTo, appendTo, appendTo, getLength, trim, writeTo, writeTo, writeTo, writeTo

Constructor Details

URIParametersMap

public URIParametersMap()

Creates an empty set of parameters.

URIParametersMap

public URIParametersMap(String queryString)

Parses the provided URL-Encoded parameter string.

Parameters:

queryString - The URL-encoded parameter string or null or "" for none

Method Details

of

public static URIParametersMap of()

of

public static URIParametersMap of(String name,
 String value)

of

public static URIParametersMap of(String name,
 Object value)

of

public static URIParametersMap of(String name1,
 String value1,
 String name2,
 String value2)

of

public static URIParametersMap of(String name1,
 Object value1,
 String name2,
 Object value2)

of

public static URIParametersMap of(String name1,
 String value1,
 String name2,
 String value2,
 String name3,
 String value3)

of

public static URIParametersMap of(String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3)

of

public static URIParametersMap of(String name1,
 String value1,
 String name2,
 String value2,
 String name3,
 String value3,
 String name4,
 String value4)

of

public static URIParametersMap of(String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4)

of

public static URIParametersMap of(String name1,
 String value1,
 String name2,
 String value2,
 String name3,
 String value3,
 String name4,
 String value4,
 String name5,
 String value5)

of

public static URIParametersMap of(String name1,
 Object value1,
 String name2,
 Object value2,
 String name3,
 Object value3,
 String name4,
 Object value4,
 String name5,
 Object value5)

toString

public String toString()

Gets the query string encoded in the default encoding IRI.ENCODING, not including the '?' prefix.

Specified by:

toString in interface URIParameters

Specified by:

toString in interface Writable

Overrides:

toString in class Object

See Also:

• URIParameters.toString()

getParameter

public String getParameter(String name)

Description copied from interface: URIParameters

Gets the value for the provided parameter name or null if doesn't exist. If the parameter has multiple values, the first value is returned.

Specified by:

getParameter in interface URIParameters

getParameterNames

public Iterator<String> getParameterNames()

Description copied from interface: URIParameters

Gets an unmodifiable iterator of the parameter names.

Specified by:

getParameterNames in interface URIParameters

getParameterValues

public List<String> getParameterValues(String name)

Description copied from interface: URIParameters

Gets an unmodifiable view of all values for a multi-value parameter or null if has no values.

Specified by:

getParameterValues in interface URIParameters

getParameterMap

public Map<String,List<String>> getParameterMap()

Description copied from interface: URIParameters

Gets an unmodifiable map view of all parameters.

Specified by:

getParameterMap in interface URIParameters

isFastToString

public boolean isFastToString()

Specified by:

isFastToString in interface URIParameters

Specified by:

isFastToString in interface Writable

add

public final URIParametersMap add(String name,
 String value)

Description copied from interface: MutableURIParameters

Adds a parameter with a single value.

Specified by:

add in interface MutableURIParameters

Parameters:

name - Required when value is not null.

value - When null, no parameter is added.

add

public URIParametersMap add(String name,
 Object value)

Description copied from interface: MutableURIParameters

Adds a parameter with a single value.

The conversion to string may be deferred, or the value may be streamed instead of being converted to a string. It is incorrect to change the state of the provided value; doing so may or may not affect the value of the resulting parameter.

When the value is an Enum, the parameter value is obtained from Enum.name() instead of Enum.toString(). This is to intuitively use enums as parameters when Enum.toString() is overridden.

Specified by:

add in interface MutableURIParameters

Parameters:

name - Required when value is not null.

value - When null, no parameter is added.

See Also:

• Coercion

add

public URIParametersMap add(String name,
 Iterable<?> values)

Description copied from interface: MutableURIParameters

Adds a parameter with multiple values.

The iteration of values will be performed immediately, but the conversion to string may be deferred, or the value may be streamed instead of being converted to a string. It is incorrect to change the state of the provided value; doing so may or may not affect the value of the resulting parameter.

When a value is an Enum, the parameter value is obtained from Enum.name() instead of Enum.toString(). This is to intuitively use enums as parameters when Enum.toString() is overridden.

Specified by:

add in interface MutableURIParameters

Parameters:

name - Required when value has any element that is not null.

values - When null, no parameters are added. When an element is null, no parameter is added.

See Also:

• Coercion

add

public URIParametersMap add(String name,
 Object... values)

Description copied from interface: MutableURIParameters

Adds a parameter with multiple values.

The iteration of values will be performed immediately, but the conversion to string may be deferred, or the value may be streamed instead of being converted to a string. It is incorrect to change the state of the provided value; doing so may or may not affect the value of the resulting parameter.

When a value is an Enum, the parameter value is obtained from Enum.name() instead of Enum.toString(). This is to intuitively use enums as parameters when Enum.toString() is overridden.

Specified by:

add in interface MutableURIParameters

Parameters:

name - Required when value has any element that is not null.

values - When null, no parameters are added. When an element is null, no parameter is added.

See Also:

• Coercion