Packages

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

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

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](kv: KV)(implicit arg0: QueryKeyValue[KV]): 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

  5. def addParam[K, V](k: K, v: V)(implicit arg0: QueryKey[K], arg1: QueryValue[V]): 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

  6. def addParams[P](kvs: P)(implicit arg0: TraversableParams[P]): 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

  7. def addParams[KV](first: KV, second: KV, kvs: KV*)(implicit arg0: QueryKeyValue[KV]): 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

  8. def addParams(other: QueryString): QueryString

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

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  11. def collect[KV](f: PartialFunction[(String, Option[String]), KV])(implicit arg0: QueryKeyValue[KV]): 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

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equalsUnordered(other: QueryString): Boolean
  14. def filter(f: ((String, Option[String])) ⇒ Boolean): QueryString

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

  15. def filterNames(f: (String) ⇒ Boolean): QueryString

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

  16. 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

  17. def filterValues(f: (String) ⇒ Boolean): QueryString

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

  18. def flatMap[A](f: ((String, Option[String])) ⇒ A)(implicit arg0: TraversableParams[A]): 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

  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def isEmpty: Boolean
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def map[KV](f: PartialFunction[(String, Option[String]), KV])(implicit arg0: QueryKeyValue[KV]): 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

  23. def mapNames[K](f: (String) ⇒ K)(implicit arg0: QueryKey[K]): QueryString

    Transforms each parameter name by applying the specified Function

  24. def mapValues[V](f: (String) ⇒ V)(implicit arg0: QueryValue[V]): QueryString

    Transforms each parameter value by applying the specified Function

  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def nonEmpty: Boolean
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def param(key: String): Option[String]
  30. lazy val paramMap: Map[String, Vector[String]]
  31. def params(key: String): Vector[Option[String]]
  32. val params: Vector[(String, Option[String])]
  33. def removeAll[K](k: Iterable[K])(implicit arg0: QueryKey[K]): 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

  34. def removeAll[K](first: K, second: K, rest: K*)(implicit arg0: QueryKey[K]): 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

    first

    Name of a Query String parameter to remove

    second

    Name of another Query String parameter to remove

    rest

    Names of more Query String parameter(s) to remove

  35. def removeAll[K](k: K)(implicit arg0: QueryKey[K]): 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

  36. def replaceAll[K, V](k: K, v: V)(implicit arg0: QueryKey[K], arg1: QueryValue[V]): 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

  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    QueryString → AnyRef → Any
  39. 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

  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped