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 percent-encoding.
When rendered, the resulting String
will have the pairs separated
by '&' while the key is separated from the value with '='
Attributes
- Companion:
- object
- Source:
- Query.scala
- Graph
- Supertypes
Members list
Value members
Concrete methods
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Compares the receiver object (this
) with the argument object (that
) for equivalence.
Compares the receiver object (this
) with the argument object (that
) for equivalence.
Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
x
of typeAny
,x.equals(x)
should returntrue
. - It is symmetric: for any instances
x
andy
of typeAny
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any instances
x
,y
, andz
of typeAny
ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is usually necessary to override hashCode
to ensure that
objects which are "equal" (o1.equals(o2)
returns true
) hash to the same scala.Int.
(o1.hashCode.equals(o2.hashCode)
).
Attributes
- that
the object to compare against this object for equality.
- Returns:
true
if the receiver object is equivalent to the argument;false
otherwise.- Definition Classes
- Any
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Calculate a hash code value for the object.
Calculate a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)
) yet
not be equal (o1.equals(o2)
returns false
). A degenerate implementation could always return 0
.
However, it is required that if two objects are equal (o1.equals(o2)
returns true
) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)
). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals
method.
Attributes
- Returns:
the hash code value for this object.
- Definition Classes
- Any
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Render the Query as a String
.
Render the Query as a String
.
Pairs are separated by '&' and keys are separated from values by '='
Attributes
- Definition Classes
- Source:
- Query.scala
Attributes
- Source:
- Query.scala
Deprecated methods
Attributes
- Deprecated
- true
- Source:
- Query.scala
Inherited methods
alias for withQueryParam
alias for withQueryParam
alias for withQueryParam
alias for withQueryParam
scala> import org.http4s.implicits._
scala> uri"www.scala.com".++?("key" -> List("value1", "value2", "value3"))
res1: Uri = www.scala.com?key=value1&key=value2&key=value3
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
alias for withQueryParam
alias for withQueryParam
alias for withQueryParam
alias for withOptionQueryParam
alias for withOptionQueryParam
alias for removeQueryParam
alias for removeQueryParam
alias for setQueryParams
alias for containsQueryParam
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
Checks if a specified parameter exists in the Query. A parameter without a name can be checked with an empty string.
Checks if a specified parameter exists in the Query. A parameter without a name can be checked with an empty string.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
Creates maybe a new Self
without the specified parameter in query.
If no parameter with the given key
exists then this
will be
returned.
Creates maybe a new Self
without the specified parameter in query.
If no parameter with the given key
exists then this
will be
returned.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
Generates a String rendering of this object
Generates a String rendering of this object
Attributes
- Inherited from:
- Renderable
- Source:
- Renderable.scala
Creates maybe a new Self
with the specified parameters. The entire
Query will be replaced with the given one.
Creates maybe a new Self
with the specified parameters. The entire
Query will be replaced with the given one.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns:
a string representation of the object.
- Definition Classes
- Renderable -> Any
- Inherited from:
- Renderable
- Source:
- Renderable.scala
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.
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.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
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.
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.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
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.
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.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
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.
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.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
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.
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.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
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.
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.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
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.
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.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
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.
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.
Attributes
- Inherited from:
- QueryOps
- Source:
- QueryOps.scala
Concrete fields
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.
Attributes
- Source:
- Query.scala