Interface UriQuery

All Superinterfaces:

Parameters

All Known Subinterfaces:

UriQueryWriteable

public interface UriQuery
extends Parameters

HTTP Query representation. Query is the section separated by ? character from the path, where each query parameter is separated by & character.

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
static UriQuery	create(String query)	Create a new HTTP query from the query string.
static UriQuery	create(String query, boolean validate)	Create a new HTTP query from the query string, validating if requested.
static UriQuery	create(URI uri)	Create URI query from a URI instance.
static UriQuery	empty()	Create an empty HTTP query.
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.

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.

Method Details

create

static UriQuery create(String query)

Create a new HTTP query from the query string. This method does not validate the raw query against specification. Malformed percent-encoded sequences are preserved literally when parameter names and values are decoded. Use create(query, true) for strict query validation.

Parameters:

query - raw query string

Returns:

HTTP query instance

See Also:

• create(String, boolean)

create

static UriQuery create(String query,
 boolean validate)

Create a new HTTP query from the query string, validating if requested.

Parameters:

query - raw query string

validate - whether to validate that the query is according to the specification

Returns:

HTTP query instance

empty

static UriQuery empty()

Create an empty HTTP query.

Returns:

HTTP query instance

create

static UriQuery create(URI uri)

Create URI query from a URI instance.

Parameters:

uri - URI to use as the source of this query

Returns:

HTTP query instance either empty (if query section of the provided URI is null) or create(String) with the raw query

rawValue

String rawValue()

Query fully encoded, without the leading ? character.

Returns:

raw query to be sent (or that was received) over the wire

value

String value()

Query NOT encoded without the leading ? character.

Returns:

query to be sent (or that was received) over the wire but decoded

getRaw

String getRaw(String name)
       throws NoSuchElementException

Get raw value (undecoded) of a query parameter by its name.

Parameters:

name - query parameter name

Returns:

value of the parameter, raw

Throws:

NoSuchElementException - in case the parameter does not exist

getAllRaw

List<String> getAllRaw(String name)
                throws NoSuchElementException

Get all raw values (undecoded) of a query parameter by its name.

Parameters:

name - query parameter name

Returns:

values of the parameter, raw

Throws:

NoSuchElementException - in case the parameter does not exist