org.http4s

Uri

case class Uri(scheme: Option[CaseInsensitiveString] = scala.None, authority: Option[Authority] = scala.None, path: Path = "", query: Query = Query.empty, fragment: Option[Fragment] = scala.None) extends QueryOps with Renderable with Product with Serializable

Representation of the Request URI Structure containing information related to a Uri. All fields except the query are expected to be url decoded.

scheme

optional Uri Scheme. eg, http, https

authority

optional Uri Authority. eg, localhost:8080, www.foo.bar

path

the Uri path

query

optional Query. Note that the query should _NOT_ be url decoded

fragment

optional Uri Fragment. Note that the fragment should _NOT_ be url decoded

Linear Supertypes
Serializable, Serializable, Product, Equals, Renderable, QueryOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Uri
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Renderable
  7. QueryOps
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Uri(scheme: Option[CaseInsensitiveString] = scala.None, authority: Option[Authority] = scala.None, path: Path = "", query: Query = Query.empty, fragment: Option[Fragment] = scala.None)

    scheme

    optional Uri Scheme. eg, http, https

    authority

    optional Uri Authority. eg, localhost:8080, www.foo.bar

    path

    the Uri path

    query

    optional Query. Note that the query should _NOT_ be url decoded

    fragment

    optional Uri Fragment. Note that the fragment should _NOT_ be url decoded

Type Members

  1. type Self = Uri

    Attributes
    protected
    Definition Classes
    Uri → QueryOps

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  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 +?[K, T](name: K, values: Seq[T])(implicit arg0: QueryParamKeyLike[K], arg1: QueryParamEncoder[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps

  7. def +?[K](name: K)(implicit arg0: QueryParamKeyLike[K]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps

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

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps

  9. def +?[T](implicit arg0: QueryParam[T]): Self

    alias for withQueryParam

    alias for withQueryParam

    Definition Classes
    QueryOps

  10. def +??[T](value: Option[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Self

    alias for withOptionQueryParam

    alias for withOptionQueryParam

    Definition Classes
    QueryOps

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

  12. def +??[T](value: Maybe[T])(implicit arg0: QueryParam[T], arg1: QueryParamEncoder[T]): Self

    alias for withMaybeQueryParam

    alias for withMaybeQueryParam

    Definition Classes
    QueryOps

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

    alias for withMaybeQueryParam

    alias for withMaybeQueryParam

    Definition Classes
    QueryOps

  14. def -?[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Self

    alias for removeQueryParam

    alias for removeQueryParam

    Definition Classes
    QueryOps

  15. def -?[T](implicit key: QueryParam[T]): Self

    alias for removeQueryParam

    alias for removeQueryParam

    Definition Classes
    QueryOps

  16. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  17. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  18. def =?[T](q: Map[String, Seq[T]])(implicit arg0: QueryParamEncoder[T]): Self

    alias for setQueryParams

    alias for setQueryParams

    Definition Classes
    QueryOps

  19. def ?[K](name: K)(implicit arg0: QueryParamKeyLike[K]): Boolean

    alias for containsQueryParam

    alias for containsQueryParam

    Definition Classes
    QueryOps

  20. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  21. val authority: Option[Authority]

    optional Uri Authority.

    optional Uri Authority. eg, localhost:8080, www.foo.bar

  22. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. def containsQueryParam[K](key: K)(implicit arg0: QueryParamKeyLike[K]): Boolean

    Definition Classes
    QueryOps

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

  25. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  26. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  27. val fragment: Option[Fragment]

    optional Uri Fragment.

    optional Uri Fragment. Note that the fragment should _NOT_ be url decoded

  28. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  29. def host: Option[Host]

  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  31. def multiParams: Map[String, Seq[String]]

    Representation of the query string as a map

    Representation of the query string as a map

    In case a parameter is available in query string but no value is there the sequence will be empty. If the value is empty the the sequence contains an empty string.

    Examples

    Query StringMap
    ?param=vMap("param" -> Seq("v"))
    ?param=Map("param" -> Seq(""))
    ?paramMap("param" -> Seq())
    ?=valueMap("" -> Seq("value"))
    ?p1=v1&p1=v2&p2=v3&p2=v3Map("p1" -> Seq("v1","v2"), "p2" -> Seq("v3","v4"))

    The query string is lazily parsed. If an error occurs during parsing an empty Map is returned.

  32. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  33. final def notify(): Unit

    Definition Classes
    AnyRef

  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  35. def params: Map[String, String]

    View of the head elements of the URI parameters in query string.

    View of the head elements of the URI parameters in query string.

    In case a parameter has no value the map returns an empty string.

    See also

    multiParams

  36. val path: Path

    the Uri path

  37. def port: Option[Int]

  38. val query: Query

    optional Query.

    optional Query. Note that the query should _NOT_ be url decoded

    Definition Classes
    Uri → QueryOps

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

  40. def render(writer: Writer): writer.type

    Base method for rendering this object efficiently

    Base method for rendering this object efficiently

    Definition Classes
    Uri → Renderable

  41. lazy val renderString: String

    Definition Classes
    Uri → Renderable

  42. def replaceQuery(query: Query): Self

    Attributes
    protected
    Definition Classes
    Uri → QueryOps

  43. def resolve(relative: Uri): Uri

  44. val scheme: Option[CaseInsensitiveString]

    optional Uri Scheme.

    optional Uri Scheme. eg, http, https

  45. def self: Self

    Attributes
    protected
    Definition Classes
    Uri → QueryOps

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

  47. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  48. def toString(): String

    Definition Classes
    Renderable → Any

  49. def userInfo: Option[UserInfo]

  50. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  51. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  52. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  53. def withMaybeQueryParam[T](value: Maybe[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

  54. def withMaybeQueryParam[T, K](key: K, value: Maybe[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 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

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

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

  57. def withPath(path: Path): Uri

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Renderable

Inherited from QueryOps

Inherited from AnyRef

Inherited from Any

Ungrouped