QueryString

Represents query string as mapped parameters.

Companion
object
class Object
trait Matchable
class Any

Value members

Abstract methods

def add(name: String, values: Seq[String]): QueryString

Adds supplied values to parameter with given name.

Adds supplied values to parameter with given name.

If a parameter with given name already exists, the newly supplied values are appended to the existing values.

Value Params
name

parameter name

values

parameter values

Returns

new query string

def contains(name: String): Boolean

Tests for parameter with given name.

Tests for parameter with given name.

Value Params
name

parameter name

def get(name: String): Option[String]

Gets first parameter value with given name if present.

Gets first parameter value with given name if present.

Value Params
name

parameter name

def getValues(name: String): Seq[String]

Gets parameter values with given name.

Gets parameter values with given name.

Value Params
name

parameter name

Note

If parameter is not present, an empty sequence is returned.

def isEmpty: Boolean

Tests for empty.

Tests for empty.

def names: Seq[String]

Gets parameter names.

Gets parameter names.

def put(name: String, values: Seq[String]): QueryString

Sets parameter with given name to supplied values.

Sets parameter with given name to supplied values.

If a parameter with given name already exists, its values are replaced with the newly supplied values.

Value Params
name

parameter name

values

parameter values

Returns

new query string

def remove(names: Seq[String]): QueryString

Removes parameters with given names.

Removes parameters with given names.

Value Params
names

parameter names

Returns

new query string

def retain(names: Seq[String]): QueryString

Retains parameters with given names, and removes all other parameters.

Retains parameters with given names, and removes all other parameters.

Value Params
names

parameter names

Returns

new query string

def toMap: Map[String, Seq[String]]

Gets Map of query string mapping each parameter to its sequence of values.

Gets Map of query string mapping each parameter to its sequence of values.

def toSeq: Seq[(String, String)]

Gets Seq of name-value pairs from query string.

Gets Seq of name-value pairs from query string.

def toSimpleMap: Map[String, String]

Gets Map of query string mapping each parameter to its first value.

Gets Map of query string mapping each parameter to its first value.

Concrete methods

Creates new query string by concatenating supplied query string.

Creates new query string by concatenating supplied query string.

Value Params
that

query string

Returns

new query string

Note

Alias to concat.

def ++(params: Map[String, Seq[String]]): QueryString

Creates new query string by concatenating supplied parameters.

Creates new query string by concatenating supplied parameters.

Value Params
params

parameters

Returns

new query string

Note

Alias to concat.

def ++(params: Seq[(String, String)]): QueryString

Creates new query string by concatenating supplied parameters.

Creates new query string by concatenating supplied parameters.

Value Params
params

parameters

Returns

new query string

Note

Alias to concat.

Creates new query string by merging supplied query string.

Creates new query string by merging supplied query string.

Value Params
that

query string

Returns

new query string

Note

Alias to merge.

def <<(params: Map[String, Seq[String]]): QueryString

Creates new query string by merging supplied parameters.

Creates new query string by merging supplied parameters.

Value Params
params

parameters

Returns

new query string

Note

Alias to merge.

def <<(params: Seq[(String, String)]): QueryString

Creates new query string by merging supplied parameters.

Creates new query string by merging supplied parameters.

Value Params
params

parameters

Returns

new query string

Note

Alias to merge.

def add(name: String, one: String, more: String*): QueryString

Adds supplied values to parameter with given name.

Adds supplied values to parameter with given name.

If a parameter with given name already exists, the newly supplied values are appended to the existing values.

Value Params
more

additional parameter values

name

parameter name

one

parameter value

Returns

new query string

def apply(name: String): String

Gets first parameter value with given name.

Gets first parameter value with given name.

Value Params
name

parameter name

Throws
java.util.NoSuchElementException

if parameter not present

Creates new query string by concatenating supplied query string.

Creates new query string by concatenating supplied query string.

Value Params
that

query string

Returns

new query string

Note

The new query string contains all values from both query strings with parameter values in that appended to those in this.

def concat(params: Map[String, Seq[String]]): QueryString

Creates new query string by concatenating supplied parameters.

Creates new query string by concatenating supplied parameters.

Value Params
params

parameters

Returns

new query string

def concat(params: Seq[(String, String)]): QueryString

Creates new query string by concatenating supplied parameters.

Creates new query string by concatenating supplied parameters.

Value Params
params

parameters

Returns

new query string

def filter(pred: (String, String) => Boolean): QueryString

Creates new query string by selecting parameters which satisfy supplied predicate.

Creates new query string by selecting parameters which satisfy supplied predicate.

Value Params
new

query string

pred

predicate

def filterNot(pred: (String, String) => Boolean): QueryString

Creates new query string by selecting parameters which do not satisfy supplied predicate.

Creates new query string by selecting parameters which do not satisfy supplied predicate.

Value Params
new

query string

pred

predicate

def getInt(name: String): Option[Int]

Gets first parameter value with given name and parses it to Int if present.

Gets first parameter value with given name and parses it to Int if present.

Value Params
name

parameter name

Throws
java.lang.NumberFormatException

if parameter value cannot be parsed to Int

def getLong(name: String): Option[Long]

Gets first parameter value with given name and parses it to Long if present.

Gets first parameter value with given name and parses it to Long if present.

Value Params
name

parameter name

Throws
java.lang.NumberFormatException

if parameter value cannot be parsed to Long

def getOrElse(name: String, default: => String): String

Gets first parameter value with given name if present; otherwise, returns default value.

Gets first parameter value with given name if present; otherwise, returns default value.

Value Params
default

default value

name

parameter name

Creates new query string by merging supplied query string.

Creates new query string by merging supplied query string.

Value Params
that

query string

Returns

new query string

Note

The new query string contains values from both query strings with parameter values in that overriding those in this.

def merge(params: Map[String, Seq[String]]): QueryString

Creates new query string by merging supplied parameters.

Creates new query string by merging supplied parameters.

Value Params
params

parameters

Returns

new query string

def merge(params: Seq[(String, String)]): QueryString

Creates new query string by merging supplied parameters.

Creates new query string by merging supplied parameters.

Value Params
params

parameters

Returns

new query string

def put(name: String, one: String, more: String*): QueryString

Sets parameter with given name to supplied values.

Sets parameter with given name to supplied values.

If the parameter with given name already exists, its values are replaced with the newly supplied values.

Value Params
more

additional parameter values

name

parameter name

one

parameter value

Returns

new query string

def remove(one: String, more: String*): QueryString

Removes parameters with given names.

Removes parameters with given names.

Value Params
more

additional parameter names

one

parameter name

Returns

new query string

def retain(one: String, more: String*): QueryString

Retains parameters with given names, and removes all other parameters.

Retains parameters with given names, and removes all other parameters.

Value Params
more

additional parameter names

one

parameter name

Returns

new query string