Package org.wiremock.url

Interface Query

All Superinterfaces:

Normalisable<Query>, org.wiremock.stringparser.ParsedString, PercentEncoded<Query>, QueryParamReader

public interface Query
extends PercentEncoded<Query>, QueryParamReader, org.wiremock.stringparser.ParsedString

Represents the query component of a URI as defined in RFC 3986 Section 3.4.

The query component contains non-hierarchical data, typically formatted as key-value pairs separated by ampersands. Query strings may contain percent-encoded characters.

Implementations must be immutable and thread-safe.

See Also:

• RFC 3986 Section 3.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Query.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final Query	EMPTY

Method Summary

Modifier and Type	Method	Description
static Query.Builder	builder()
static Query	encode(String unencoded)	Encodes a string into a valid query with proper percent-encoding.
Query	normalise()	Returns a normalised form of this value.
static Query	parse(String query)	Parses a string into a query.
default Query	replace(String key, @Nullable String value, @Nullable String... otherValues)
default Query	replace(QueryParamKey key, @Nullable QueryParamValue value, @Nullable QueryParamValue... otherValues)
default Query	replace(QueryParamKey key, List<? extends @Nullable QueryParamValue> values)
Query.Builder	thaw()
default Query	transform(Consumer<Query.Builder> transformer)
default Query	with(String key, @Nullable String value, @Nullable String... otherValues)
default Query	with(QueryParamKey key, @Nullable QueryParamValue value, @Nullable QueryParamValue... otherValues)
default Query	with(QueryParamKey key, List<? extends @Nullable QueryParamValue> values)
default Query	without(String key)
default Query	without(String key, @Nullable String value, @Nullable String... otherValues)
default Query	without(QueryParamKey key)
default Query	without(QueryParamKey key, @Nullable QueryParamValue value, @Nullable QueryParamValue... otherValues)
default Query	without(QueryParamKey key, List<? extends @Nullable QueryParamValue> values)

Methods inherited from interface org.wiremock.url.Normalisable

isNormalForm

Methods inherited from interface org.wiremock.stringparser.ParsedString

toString

Methods inherited from interface org.wiremock.url.PercentEncoded

decode, isEmpty, length

Methods inherited from interface org.wiremock.url.QueryParamReader

asDecodedMap, asMap, contains, contains, get, get, getDecoded, getEntries, getFirst, getFirst, getFirstDecoded, getKeys

Field Details

EMPTY

static final Query EMPTY

Method Details

parse

static Query parse(String query)
            throws IllegalQuery

Parses a string into a query.

Parameters:

query - the string to parse

Returns:

the parsed query

Throws:

IllegalQuery - if the string is not a valid query

encode

static Query encode(String unencoded)

Encodes a string into a valid query with proper percent-encoding.

Parameters:

unencoded - the unencoded string

Returns:

the encoded query

normalise

Query normalise()

Description copied from interface: Normalisable

Returns a normalised form of this value.

Specified by:

normalise in interface Normalisable<Query>

Returns:

a normalised value

with

default Query with(String key,
 @Nullable String value,
 @Nullable String... otherValues)

with

default Query with(QueryParamKey key,
 @Nullable QueryParamValue value,
 @Nullable QueryParamValue... otherValues)

with

default Query with(QueryParamKey key,
 List<? extends @Nullable QueryParamValue> values)

replace

default Query replace(String key,
 @Nullable String value,
 @Nullable String... otherValues)

replace

default Query replace(QueryParamKey key,
 @Nullable QueryParamValue value,
 @Nullable QueryParamValue... otherValues)

replace

default Query replace(QueryParamKey key,
 List<? extends @Nullable QueryParamValue> values)

without

default Query without(String key)

without

default Query without(QueryParamKey key)

without

default Query without(String key,
 @Nullable String value,
 @Nullable String... otherValues)

without

default Query without(QueryParamKey key,
 @Nullable QueryParamValue value,
 @Nullable QueryParamValue... otherValues)

without

default Query without(QueryParamKey key,
 List<? extends @Nullable QueryParamValue> values)

builder

static Query.Builder builder()

thaw

Query.Builder thaw()

transform

default Query transform(Consumer<Query.Builder> transformer)