Interface UriQueryWriteable

All Superinterfaces:

Parameters, UriQuery

public interface UriQueryWriteable
extends UriQuery

Mutable HTTP query.

Nested Class Summary

Nested classes/interfaces inherited from interface Parameters

Parameters.Builder

Modifier and Type	Interface	Description
static class	Parameters.Builder	Builder of a new Parameters instance.

Field Summary

Fields inherited from interface Parameters

GENERIC_TYPE

Modifier and Type	Field	Description
static final GenericType<Parameters>	GENERIC_TYPE	Generic type for parameters.

Method Summary

Modifier and Type	Method	Description
UriQueryWriteable	add(String name, String value)	Add a new query parameter or add a value to existing.
void	clear()	Clear all query parameters.
static UriQueryWriteable	create()	Create a new HTTP Query to write parameter into.
UriQueryWriteable	from(UriQuery uriQuery)	Update this query by copying all names and their value(s) from the provided query.
void	fromQueryString(String queryString)	Update from a query string (with encoded values).
UriQueryWriteable	remove(String name)	Remove a query parameter.
UriQueryWriteable	remove(String name, Consumer<List<String>> removedConsumer)	Remove a query parameter.
UriQueryWriteable	set(String name, String... value)	Set a query parameter with values.
UriQueryWriteable	setIfAbsent(String name, String... value)	Set a query parameter with values, if not already defined.

Methods inherited from interface Parameters

all, all, allValues, allValues, component, contains, first, get, isEmpty, names, size, toMap

Modifier and Type	Method	Description
List<String>	all(String name)	Get all values.
default List<String>	all(String name, Supplier<List<String>> defaultValues)	Get all values using a default value supplier if the parameter does not exist.
List<Value<String>>	allValues(String name)	A list of values for the named parameter.
default List<Value<String>>	allValues(String name, Supplier<List<Value<String>>> defaultValues)	Get all values using a default value supplier if the parameter does not exist.
String	component()	Name of the component of these parameters.
boolean	contains(String name)	Whether these parameters contain the provided name.
OptionalValue<String>	first(String name)	Get the first value as an optional.
String	get(String name)	Get the first value.
default boolean	isEmpty()	Whether these parameters are empty.
Set<String>	names()	Set of parameter names.
int	size()	Number of parameter names in these parameters.
default Map<String, List<String>>	toMap()	Get a map representation of these parameters.

Methods inherited from interface UriQuery

getAllRaw, getRaw, rawValue, value

Modifier and Type	Method	Description
List<String>	getAllRaw(String name)	Get all raw values (undecoded) of a query parameter by its name.
String	getRaw(String name)	Get raw value (undecoded) of a query parameter by its name.
String	rawValue()	Query fully encoded, without the leading ? character.
String	value()	Query NOT encoded without the leading ? character.

Method Details

create

static UriQueryWriteable create()

Create a new HTTP Query to write parameter into.

Returns:

new mutable HTTP query

from

UriQueryWriteable from(UriQuery uriQuery)

Update this query by copying all names and their value(s) from the provided query.

Parameters:

uriQuery - uri query to read

Returns:

updated instance

set

UriQueryWriteable set(String name,
 String... value)

Set a query parameter with values.

Parameters:

name - name of the parameter

value - value(s) of the parameter

Returns:

this instance

add

UriQueryWriteable add(String name,
 String value)

Add a new query parameter or add a value to existing.

Parameters:

name - name of the parameter

value - additional value of the parameter

Returns:

this instance

setIfAbsent

UriQueryWriteable setIfAbsent(String name,
 String... value)

Set a query parameter with values, if not already defined.

Parameters:

name - name of the parameter

value - value(s) of the parameter

Returns:

this instance

remove

UriQueryWriteable remove(String name)

Remove a query parameter.

Parameters:

name - name of the parameter

Returns:

this instance

remove

UriQueryWriteable remove(String name,
 Consumer<List<String>> removedConsumer)

Remove a query parameter.

Parameters:

name - name of the parameter

removedConsumer - consumer of existing values, only called if there was an existing value

Returns:

this instance

fromQueryString

void fromQueryString(String queryString)

Update from a query string (with encoded values).

This documentation (and behavior) has been changed, as we cannot create a proper query from decoded values, as these may contain characters used to split the query. Malformed percent-encoded sequences are preserved literally when parameter names and values are decoded. Use UriValidator.validateQuery(String) for strict query validation before updating this instance.

Parameters:

queryString - encoded query string to update this instance

clear

void clear()

Clear all query parameters.