Module com.aoapps.net.types

Package com.aoapps.net

Interface MutableURIParameters

All Superinterfaces:

URIParameters, Writable

All Known Implementing Classes:

URIParametersMap

public interface MutableURIParameters
extends URIParameters

Provides read-write access to URI parameters.

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method	Description
default MutableURIParameters	add(String name, Iterable<?> values)	Adds a parameter with multiple values.
default MutableURIParameters	add(String name, Object value)	Adds a parameter with a single value.
default MutableURIParameters	add(String name, Object... values)	Adds a parameter with multiple values.
MutableURIParameters	add(String name, String value)	Adds a parameter with a single value.
default void	addParameter(String name, String value)	Deprecated. Please use add(java.lang.String, java.lang.String) directly.
default void	addParameters(String name, Iterable<? extends String> values)	Deprecated. Please use add(java.lang.String, java.lang.Iterable) directly.

Methods inherited from interface com.aoapps.net.URIParameters

appendTo, appendTo, appendTo, appendTo, getLength, getParameter, getParameterMap, getParameterNames, getParameterValues, isFastToString, toString, trim, writeTo, writeTo, writeTo, writeTo

Method Details

add

MutableURIParameters add(String name,
 String value)

Adds a parameter with a single value.

Parameters:

name - Required when value is not null.

value - When null, no parameter is added.

add

default MutableURIParameters add(String name,
 Object value)

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.

Parameters:

name - Required when value is not null.

value - When null, no parameter is added.

See Also:

• Coercion

addParameter

@Deprecated
default void addParameter(String name,
 String value)

Deprecated.

Please use add(java.lang.String, java.lang.String) directly.

Adds a parameter with a single value.

Parameters:

name - May not be null.

value - May not be null.

add

default MutableURIParameters add(String name,
 Iterable<?> values)

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.

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

default MutableURIParameters add(String name,
 Object... values)

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.

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

addParameters

@Deprecated
default void addParameters(String name,
 Iterable<? extends String> values)

Deprecated.

Please use add(java.lang.String, java.lang.Iterable) directly.

Adds a parameter with multiple values.

Parameters:

name - Required when values is not null.

values - When null, no parameters are added. May not contain any null elements.