Builder

A mutable builder used to construct QueryParameters instances

Constructors

Link copied to clipboard
constructor()

Initialize an empty QueryParameters builder

Properties

Link copied to clipboard

Get or set the query parameters as a decoded string.

Link copied to clipboard

Gets the query parameters as decoded keys/values. Changes to this map are reflected in the encodedParameters map as well.

Link copied to clipboard

Get or set the query parameters as an encoded string.

Link copied to clipboard

Gets the query parameters as encoded keys/values. Changes to this map are reflected in the decodedParameters map as well.

Link copied to clipboard

A flag indicating whether to force inclusion of the ? query separator even when there are no parameters (e.g., http://foo.com? vs http://foo.com).

Inherited properties

Link copied to clipboard
Link copied to clipboard
open override val entryValues: <Error class: unknown class><Map.Entry<K, V>>

Gets a Sequence of key-value pairs. A given key will appear multiple times in the sequence if it is associated with multiple values. This sequence lazily enumerates over keys and values in the multimap and may reflect changes which occurred after the iteration began.

Link copied to clipboard
open override val keys: MutableSet<Encodable>
Link copied to clipboard
open override val size: Int
Link copied to clipboard

Functions

Link copied to clipboard

Build a new QueryParameters from the currently-configured builder values

Link copied to clipboard

Copies the state from other into this builder. All existing state is overwritten.

Link copied to clipboard

Applies the given DSL block to the decoded query parameters. Changes to this map are reflected in the encodedParameters map as well.

Link copied to clipboard

Applies the given DSL block to the encoded query parameters. Changes to this map are reflected in the decodedParameters map as well.

Inherited functions

Link copied to clipboard
open override fun add(key: Encodable, value: Encodable): Boolean

Adds an association from the given key to the given value

open override fun add(key: Encodable, index: Int, value: Encodable)

Adds an association from the given key to the given value, inserting it at the given index in the list of values already associated with the key.

Link copied to clipboard
open override fun addAll(other: Map<Encodable, List<Encodable>>)

Adds all the key-value associations from another map into this one. This will append to the existing associations, not merge or deduplicate. This operation copies from the given values lists. Later changes to those lists do not affect this collection.

open override fun addAll(key: Encodable, values: Collection<Encodable>): Boolean

Adds associations from the given key to the given values. This will append to the existing associations, not merge or deduplicate. This operation copies from the given values. Later changes to the collection do not affect this instance.

open override fun addAll(key: Encodable, index: Int, values: Collection<Encodable>): Boolean

Adds associations from the given key to the given values, inserting them at the given index in the list of values already associated with the key. This operation copies from the given values. Later changes to the collection do not affect this instance.

Link copied to clipboard
open override fun clear()
Link copied to clipboard
open override fun contains(key: Encodable, value: Encodable): Boolean

Checks if the specified value is present for the given key. Returns false if key is not present or if it is not associated with value.

Link copied to clipboard
open override fun containsKey(key: Encodable): Boolean
Link copied to clipboard
open override fun containsValue(value: MutableList<Encodable>): Boolean
Link copied to clipboard
open operator override fun get(key: Encodable): MutableList<Encodable>?
Link copied to clipboard
open override fun isEmpty(): Boolean
Link copied to clipboard
open override fun put(key: Encodable, value: Encodable): MutableList<Encodable>?

Sets an association from the given key to the given value. This operation replaces any existing associations between key and other values.

open override fun put(key: Encodable, value: MutableList<Encodable>): MutableList<Encodable>?
Link copied to clipboard
open override fun putAll(from: Map<out Encodable, MutableList<Encodable>>)
Link copied to clipboard
open override fun remove(key: Encodable, value: Encodable): Boolean

Removes the association from the given key to the given value.

Link copied to clipboard
open override fun removeAll(key: Encodable, values: Collection<Encodable>): Boolean?

Removes the associations from the given key to the given values.

Link copied to clipboard
open override fun removeAt(key: Encodable, index: Int): Encodable?

Removes the association from the given key to the value at the given index in the list of existing associations.

Link copied to clipboard
open override fun retainAll(key: Encodable, values: Collection<Encodable>): Boolean?

Retains only associations from the given key to the given values. Any other associations from the given key to other values are removed.

Link copied to clipboard
open override fun toMultiMap(): MultiMap<Encodable, Encodable>

Returns a new read-only multimap containing all the key-value associations from this multimap