Packages

final class Query extends QueryOps with Renderable

Collection representation of a query string

It is a indexed sequence of key and maybe a value pairs which maps precisely to a query string, modulo the identity of separators.

When rendered, the resulting String will have the pairs separated by '&' while the key is separated from the value with '='

Source
Query.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Query
  2. Renderable
  3. QueryOps
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Self = Query
    Attributes
    protected
    Definition Classes
    QueryQueryOps

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Query to any2stringadd[Query] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def +*?[T](values: Seq[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  5. def +*?[T](value: T)(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  6. def ++(pairs: Iterable[(String, Option[String])]): Query
  7. def +:(elem: KeyValue): Query
  8. def +?[K, T](name: K, values: Seq[T])(implicit arg0: QueryParamKeyLike[K], arg1: QueryParamEncoder[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  9. def +?[K](name: K)(implicit arg0: QueryParamKeyLike[K]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  10. def +?[K, T](name: K, value: T)(implicit arg0: QueryParamKeyLike[K], arg1: QueryParamEncoder[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  11. def +?[T](implicit arg0: QueryParam[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps
  12. def +??[T](value: Option[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Self

    alias for withOptionQueryParam

    alias for withOptionQueryParam

    Definition Classes
    QueryOps
  13. def +??[K, T](name: K, value: Option[T])(implicit arg0: QueryParamKeyLike[K], arg1: QueryParamEncoder[T]): Self

    alias for withOptionQueryParam

    alias for withOptionQueryParam

    Definition Classes
    QueryOps
  14. def ->[B](y: B): (Query, B)
    Implicit
    This member is added by an implicit conversion from Query to ArrowAssoc[Query] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  15. def -?[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Self

    alias for removeQueryParam

    alias for removeQueryParam

    Definition Classes
    QueryOps
  16. def -?[T](implicit key: QueryParam[T]): Self

    alias for removeQueryParam

    alias for removeQueryParam

    Definition Classes
    QueryOps
  17. def :+(elem: KeyValue): Query
  18. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. def =?[T](q: Map[String, List[T]])(implicit arg0: QueryParamEncoder[T]): Self

    alias for setQueryParams

    alias for setQueryParams

    Definition Classes
    QueryOps
  20. def ?[K](name: K)(implicit arg0: QueryParamKeyLike[K]): Boolean

    alias for containsQueryParam

    alias for containsQueryParam

    Definition Classes
    QueryOps
  21. def apply(idx: Int): KeyValue
  22. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  23. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. def containsQueryParam[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Boolean
    Definition Classes
    QueryOps
  25. def containsQueryParam[T](implicit key: QueryParam[T]): Boolean

    Checks if a specified parameter exists in the Query.

    Checks if a specified parameter exists in the Query. A parameter without a name can be checked with an empty string.

    Definition Classes
    QueryOps
  26. def drop(n: Int): Query
  27. def dropRight(n: Int): Query
  28. def ensuring(cond: (Query) ⇒ Boolean, msg: ⇒ Any): Query
    Implicit
    This member is added by an implicit conversion from Query to Ensuring[Query] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: (Query) ⇒ Boolean): Query
    Implicit
    This member is added by an implicit conversion from Query to Ensuring[Query] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def ensuring(cond: Boolean, msg: ⇒ Any): Query
    Implicit
    This member is added by an implicit conversion from Query to Ensuring[Query] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. def ensuring(cond: Boolean): Query
    Implicit
    This member is added by an implicit conversion from Query to Ensuring[Query] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def equals(that: Any): Boolean
    Definition Classes
    Query → AnyRef → Any
  34. def exists(f: (KeyValue) ⇒ Boolean): Boolean
  35. def filter(f: (KeyValue) ⇒ Boolean): Query
  36. def filterNot(f: (KeyValue) ⇒ Boolean): Query
  37. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def foldLeft[Z](z: Z)(f: (Z, KeyValue) ⇒ Z): Z
  39. def foldRight[Z](z: Eval[Z])(f: (KeyValue, Eval[Z]) ⇒ Eval[Z]): Eval[Z]
  40. def foreach(f: (KeyValue) ⇒ Unit): Unit
  41. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Query to StringFormat[Query] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. def hashCode(): Int
    Definition Classes
    Query → AnyRef → Any
  44. def isEmpty: Boolean
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. def length: Int
  47. lazy val multiParams: Map[String, Seq[String]]

    Map[String, Seq[String]] representation of the Query

    Map[String, Seq[String]] representation of the Query

    Params are represented as a Seq[String] and may be empty.

  48. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. def nonEmpty: Boolean
  50. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  52. val pairs: Vector[KeyValue]
  53. lazy val params: Map[String, String]

    Map[String, String] representation of the Query

    Map[String, String] representation of the Query

    If multiple values exist for a key, the first is returned. If none exist, the empty String "" is returned.

  54. val query: Query
    Attributes
    protected
    Definition Classes
    QueryQueryOps
  55. def removeQueryParam[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Self

    Creates maybe a new Self without the specified parameter in query.

    Creates maybe a new Self without the specified parameter in query. If no parameter with the given key exists then this will be returned.

    Definition Classes
    QueryOps
  56. def render(writer: Writer): writer.type

    Render the Query as a String.

    Render the Query as a String.

    Pairs are separated by '&' and keys are separated from values by '='

    Definition Classes
    QueryRenderable
  57. def renderString: String

    Generates a String rendering of this object

    Generates a String rendering of this object

    Definition Classes
    Renderable
  58. def replaceQuery(query: Query): Self
    Attributes
    protected
    Definition Classes
    QueryQueryOps
  59. def self: Self
    Attributes
    protected
    Definition Classes
    QueryQueryOps
  60. def setQueryParams[K, T](params: Map[K, Seq[T]])(implicit arg0: QueryParamKeyLike[K], arg1: QueryParamEncoder[T]): Self

    Creates maybe a new Self with the specified parameters.

    Creates maybe a new Self with the specified parameters. The entire Query will be replaced with the given one.

    Definition Classes
    QueryOps
  61. def slice(from: Int, until: Int): Query
  62. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  63. def toList: List[(String, Option[String])]
  64. def toString(): String
    Definition Classes
    Renderable → Any
  65. def toVector: Vector[(String, Option[String])]
  66. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  69. def withMultiValueQueryParams[T, K](params: Map[K, Seq[T]])(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with all the specified parameters in the Query.

    Creates maybe a new Self with all the specified parameters in the Query. If any of the given parameters' keys already exists, the value(s) will be replaced. Parameters from the input map are added left-to-right, so if a parameter with a given key is specified more than once, it will be self-overwriting.

    Definition Classes
    QueryOps
  70. def withOptionQueryParam[T](value: Option[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Self

    Creates maybe a new Self with the specified parameter in the Query.

    Creates maybe a new Self with the specified parameter in the Query. If the value is empty or if the parameter to be added equal the existing entry the same instance of Self will be returned. If a parameter with the given name already exists the values will be replaced.

    Definition Classes
    QueryOps
  71. def withOptionQueryParam[T, K](key: K, value: Option[T])(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with the specified parameter in the Query.

    Creates maybe a new Self with the specified parameter in the Query. If the value is empty or if the parameter to be added equal the existing entry the same instance of Self will be returned. If a parameter with the given key already exists the values will be replaced.

    Definition Classes
    QueryOps
  72. def withQueryParam[T, K](key: K, values: Seq[T])(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with the specified parameters in the Query.

    Creates maybe a new Self with the specified parameters in the Query. If a parameter with the given key already exists the values will be replaced.

    Definition Classes
    QueryOps
  73. def withQueryParam[T, K](key: K, value: T)(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with the specified parameter in the Query.

    Creates maybe a new Self with the specified parameter in the Query. If a parameter with the given key already exists the values will be replaced. If the parameter to be added equal the existing entry the same instance of Self will be returned.

    Definition Classes
    QueryOps
  74. def withQueryParam[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Self

    Creates a new Self with the specified parameter in the Query.

    Creates a new Self with the specified parameter in the Query. If a parameter with the given key already exists the values will be replaced with an empty list.

    Definition Classes
    QueryOps
  75. def withQueryParam[T](implicit arg0: QueryParam[T]): Self

    Creates a new Self with the specified parameter in the Query.

    Creates a new Self with the specified parameter in the Query. If a parameter with the given QueryParam.key already exists the values will be replaced with an empty list.

    Definition Classes
    QueryOps
  76. def withQueryParams[T, K](params: Map[K, T])(implicit arg0: QueryParamEncoder[T], arg1: QueryParamKeyLike[K]): Self

    Creates maybe a new Self with all the specified parameters in the Query.

    Creates maybe a new Self with all the specified parameters in the Query. If any of the given parameters' keys already exists, the value(s) will be replaced. Parameters from the input map are added left-to-right, so if a parameter with a given key is specified more than once, it will be self-overwriting.

    Definition Classes
    QueryOps
  77. def [B](y: B): (Query, B)
    Implicit
    This member is added by an implicit conversion from Query to ArrowAssoc[Query] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Renderable

Inherited from QueryOps

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Query to any2stringadd[Query]

Inherited by implicit conversion StringFormat from Query to StringFormat[Query]

Inherited by implicit conversion Ensuring from Query to Ensuring[Query]

Inherited by implicit conversion ArrowAssoc from Query to ArrowAssoc[Query]

Ungrouped