Packages

case class QueryString(params: Vector[(String, Option[String])])(implicit config: UriConfig = UriConfig.default) extends Product with Serializable

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueryString
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new QueryString(params: Vector[(String, Option[String])])(implicit config: UriConfig = UriConfig.default)

Type Members

  1. type ParamToString = PartialFunction[(String, Option[String]), String]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addParam(kv: (String, String)): QueryString

    Adds a new Query String parameter key-value pair.

  5. def addParam(k: String): QueryString

    Adds a new parameter key with no value, e.g.

    Adds a new parameter key with no value, e.g. ?param

    returns

    A new instance with the new parameter added

  6. def addParam(k: String, v: Option[String]): QueryString

    Pairs with values, such as ("param", Some("value")), represent query params with values, i.e ?param=value

    Pairs with values, such as ("param", Some("value")), represent query params with values, i.e ?param=value

    By default, pairs without values, such as ("param", None), represent query params without values, i.e ?param Using a UriConfig(renderQuery = ExcludeNones), will cause pairs with None values not to be rendered

    returns

    A new instance with the new parameter added

  7. def addParam(k: String, v: String): QueryString

    Adds a new parameter key-value pair.

    Adds a new parameter key-value pair.

    returns

    A new instance with the new parameter added

  8. def addParamOptionValue(kv: (String, Option[String])): QueryString

    Adds a new Query String parameter key-value pair.

    Adds a new Query String parameter key-value pair.

    Pairs with values, such as ("param", Some("value")), represent query params with values, i.e ?param=value Using a UriConfig(renderQuery = ExcludeNones), will cause pairs with None values not to be rendered

    By default, pairs without values, such as ("param", None), represent query params without values, i.e ?param

  9. def addParams(kvs: Iterable[(String, String)]): QueryString

    Adds all the specified key-value pairs as parameters to the query

  10. def addParams(kvs: (String, String)*): QueryString

    Adds all the specified key-value pairs as parameters to the query

  11. def addParams(other: QueryString): QueryString

    Adds all the specified key-value pairs as parameters to the query

  12. def addParamsOptionValues(kvs: (String, Option[String])*): QueryString

    Adds all the specified key-value pairs as parameters to the query

    Adds all the specified key-value pairs as parameters to the query

    Pairs with values, such as ("param", Some("value")), represent query params with values, i.e ?param=value

    By default, pairs without values, such as ("param", None), represent query params without values, i.e ?param Using a UriConfig(renderQuery = ExcludeNones), will cause pairs with None values not to be rendered

  13. def addParamsOptionValues(kvs: Iterable[(String, Option[String])]): QueryString

    Adds all the specified key-value pairs as parameters to the query

    Adds all the specified key-value pairs as parameters to the query

    Pairs with values, such as ("param", Some("value")), represent query params with values, i.e ?param=value

    By default, pairs without values, such as ("param", None), represent query params without values, i.e ?param Using a UriConfig(renderQuery = ExcludeNones), will cause pairs with None values not to be rendered

  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. def collect(f: PartialFunction[(String, Option[String]), (String, Option[String])]): QueryString

    Transforms the Query String by applying the specified PartialFunction to each Query String Parameter

    Transforms the Query String by applying the specified PartialFunction to each Query String Parameter

    Parameters not defined in the PartialFunction will be removed.

    f

    A function that returns a new Parameter when applied to each Parameter

  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def filter(f: ((String, Option[String])) => Boolean): QueryString

    Filters out just the parameters for which the provided function holds true

  19. def filterNames(f: (String) => Boolean): QueryString

    Filters out just the parameters for which the provided function holds true when applied to the parameter name

  20. def filterOptionValues(f: (Option[String]) => Boolean): QueryString

    Filters out just the parameters for which the provided function holds true when applied to the parameter value

  21. def filterValues(f: (String) => Boolean): QueryString

    Filters out just the parameters for which the provided function holds true when applied to the parameter value

  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  23. def flatMap(f: ((String, Option[String])) => Iterable[(String, Option[String])]): QueryString

    Transforms each parameter by applying the specified Function

    Transforms each parameter by applying the specified Function

    f

    A function that returns a collection of Parameters when applied to each parameter

  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def isEmpty: Boolean
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def map(f: PartialFunction[(String, Option[String]), (String, Option[String])]): QueryString

    Transforms the Query String by applying the specified PartialFunction to each Query String Parameter

    Transforms the Query String by applying the specified PartialFunction to each Query String Parameter

    Parameters not defined in the PartialFunction will be left as-is.

    f

    A function that returns a new Parameter when applied to each Parameter

  28. def mapNames(f: (String) => String): QueryString

    Transforms each parameter name by applying the specified Function

  29. def mapValues(f: (String) => String): QueryString

    Transforms each parameter value by applying the specified Function

  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def nonEmpty: Boolean
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def param(key: String): Option[String]
  35. lazy val paramMap: Map[String, Vector[String]]
  36. def params(key: String): Vector[Option[String]]
  37. val params: Vector[(String, Option[String])]
  38. def productElementNames: Iterator[String]
    Definition Classes
    Product
  39. def removeAll(k: Iterable[String]): QueryString

    Removes all Query String parameters with a name in the specified list

    Removes all Query String parameters with a name in the specified list

    k

    Names of Query String parameter(s) to remove

  40. def removeAll(k: String*): QueryString

    Removes all Query String parameters with a name in the specified list

    Removes all Query String parameters with a name in the specified list

    k

    Names of Query String parameter(s) to remove

  41. def removeAll(k: String): QueryString

    Removes all Query String parameters with the specified key

    Removes all Query String parameters with the specified key

    k

    Key for the Query String parameter(s) to remove

  42. def replaceAll(k: String, v: String): QueryString

    Replaces the all existing Query String parameters with the specified key with a single Query String parameter with the specified value.

    Replaces the all existing Query String parameters with the specified key with a single Query String parameter with the specified value.

    k

    Key for the Query String parameter(s) to replace

    v

    value to replace with

    returns

    A new QueryString with the result of the replace

  43. def replaceAll(k: String, v: Option[String]): QueryString

    Replaces the all existing Query String parameters with the specified key with a single Query String parameter with the specified value.

    Replaces the all existing Query String parameters with the specified key with a single Query String parameter with the specified value.

    If the value passed in is None, then all Query String parameters with the specified key are replaces with a valueless query param. E.g. replaceParams("q", None) would turn ?q=1&q=2 into ?q

    k

    Key for the Query String parameter(s) to replace

    v

    value to replace with

    returns

    A new QueryString with the result of the replace

  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. def toString(): String
    Definition Classes
    QueryString → AnyRef → Any
  46. def toStringRaw: String

    Returns the query string with no encoding taking place (e.g.

    Returns the query string with no encoding taking place (e.g. non ASCII characters will not be percent encoded)

    returns

    String containing the raw query string for this Uri

  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped