abstract class Uri extends AnyRef

Represents an Uri. Use methods on the class to create modified copies of a given instance.

Source
Uri.java
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Uri
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Uri()

Abstract Value Members

  1. abstract def addPathSegment(segment: String): Uri

    Returns a copy of this instance with a path segment added at the end.

  2. abstract def asScala(): scaladsl.model.Uri

    Returns the Scala DSL representation of this Uri.

  3. abstract def fragment(fragment: Optional[String]): Uri

    Returns a copy of this instance with a new optional fragment.

  4. abstract def fragment(fragment: String): Uri

    Returns a copy of this instance with a new fragment.

  5. abstract def fragment(): Optional[String]

    Returns the fragment part of this Uri.

  6. abstract def getHost(): Host

    Returns the host of this instance

  7. abstract def getPathString(): String

    Returns the path of this instance

  8. abstract def getPort(): Int

    Returns the port of this instance

  9. abstract def getScheme(): String

    Returns the scheme of this instance

  10. abstract def getUserInfo(): String

    Returns the user info of this instance

  11. abstract def host(host: String): Uri

    Returns a copy of this instance with a new host.

  12. abstract def host(host: Host): Uri

    Returns a copy of this instance with a new Host.

  13. abstract def host(): Host

    Returns the Host of this Uri.

  14. abstract def isAbsolute(): Boolean

    Returns if this is an absolute Uri.

  15. abstract def isEmpty(): Boolean

    Returns if this is an empty Uri.

  16. abstract def isRelative(): Boolean

    Returns if this is a relative Uri.

  17. abstract def path(path: String): Uri

    Returns a copy of this instance with a new path.

  18. abstract def path(): String

    Returns a String representation of the path of this Uri.

  19. abstract def pathSegments(): Iterable[String]

    Returns the path segments of this Uri as an Iterable.

  20. abstract def port(port: Int): Uri

    Returns a copy of this instance with a new port.

  21. abstract def port(): Int

    Returns the port of this Uri.

  22. abstract def query(query: Query): Uri

    Returns a copy of this instance with a new query.

  23. abstract def query(charset: Charset, mode: ParsingMode): Query

    Returns the parsed Query instance of this Uri using the given charset and parsing mode.

  24. abstract def query(): Query

    Returns the parsed Query instance of this Uri.

  25. abstract def queryString(charset: Charset): Optional[String]

    Returns a decoded String representation of the query of this Uri.

  26. abstract def rawQueryString(rawQuery: String, strict: Boolean): Uri

    Returns a copy of this instance with a new query.

    Returns a copy of this instance with a new query.

    Characters that are not within the range described at https://tools.ietf.org/html/rfc3986#section-3.4 should be percent-encoded. Characters that are in that range may or may not be percent-encoded, and depending on how the query string is parsed this might be relevant: for example, when interpreting the query string as 'key=value' pairs you could use the percent-encoded '=' ('%22) to include a '=' in the key or value.

    strict

    depending on the 'strict' flag, characters outside of the range allowed by RFC3986 will either cause a IllegalUriException or be automatically percent-encoded. Be aware that relying on automatic percent-encoding is usually a programming error.

  27. abstract def rawQueryString(rawQuery: String): Uri

    Returns a copy of this instance with a new query.

    Returns a copy of this instance with a new query.

    Characters that are not within the range described at https://tools.ietf.org/html/rfc3986#section-3.4 should be percent-encoded. Characters that are in that range may or may not be percent-encoded, and depending on how the query string is parsed this might be relevant: for example, when interpreting the query string as 'key=value' pairs you could use the percent-encoded '=' ('%22) to include a '=' in the key or value.

    When characters are encountered that are outside of the RFC3986 range they are automatically percent-encoded, but be aware that relying on this is usually a programming error.

  28. abstract def rawQueryString(): Optional[String]

    Returns an undecoded String representation of the query of this Uri.

  29. abstract def scheme(scheme: String): Uri

    Returns a copy of this instance with a new scheme.

  30. abstract def scheme(): String

    Returns the scheme of this Uri.

  31. abstract def toRelative(): Uri

    Returns a copy of this instance that is relative.

  32. abstract def userInfo(userInfo: String): Uri

    Returns a copy of this instance with new user-info.

  33. abstract def userInfo(): String

    Returns the user-info of this Uri.

Concrete 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 Uri toany2stringadd[Uri] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Uri, B)
    Implicit
    This member is added by an implicit conversion from Uri toArrowAssoc[Uri] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (Uri) => Boolean, msg: => Any): Uri
    Implicit
    This member is added by an implicit conversion from Uri toEnsuring[Uri] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Uri) => Boolean): Uri
    Implicit
    This member is added by an implicit conversion from Uri toEnsuring[Uri] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Uri
    Implicit
    This member is added by an implicit conversion from Uri toEnsuring[Uri] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Uri
    Implicit
    This member is added by an implicit conversion from Uri toEnsuring[Uri] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Uri toStringFormat[Uri] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Uri, B)
    Implicit
    This member is added by an implicit conversion from Uri toArrowAssoc[Uri] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromUri to any2stringadd[Uri]

Inherited by implicit conversion StringFormat fromUri to StringFormat[Uri]

Inherited by implicit conversion Ensuring fromUri to Ensuring[Uri]

Inherited by implicit conversion ArrowAssoc fromUri to ArrowAssoc[Uri]

Ungrouped