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