abstract class Uri extends AnyRef
Represents an Uri. Use methods on the class to create modified copies of a given instance.
- Source
- Uri.java
- Alphabetic
- By Inheritance
- Uri
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Uri()
Abstract Value Members
- abstract def addPathSegment(segment: String): Uri
Returns a copy of this instance with a path segment added at the end.
- abstract def asScala(): scaladsl.model.Uri
Returns the Scala DSL representation of this Uri.
- abstract def fragment(fragment: Optional[String]): Uri
Returns a copy of this instance with a new optional fragment.
- abstract def fragment(fragment: String): Uri
Returns a copy of this instance with a new fragment.
- abstract def fragment(): Optional[String]
Returns the fragment part of this Uri.
- abstract def getHost(): Host
Returns the host of this instance
- abstract def getPathString(): String
Returns the path of this instance
- abstract def getPort(): Int
Returns the port of this instance
- abstract def getScheme(): String
Returns the scheme of this instance
- abstract def getUserInfo(): String
Returns the user info of this instance
- abstract def host(host: String): Uri
Returns a copy of this instance with a new host.
- abstract def host(host: Host): Uri
Returns a copy of this instance with a new Host.
- abstract def host(): Host
Returns the Host of this Uri.
- abstract def isAbsolute(): Boolean
Returns if this is an absolute Uri.
- abstract def isEmpty(): Boolean
Returns if this is an empty Uri.
- abstract def isRelative(): Boolean
Returns if this is a relative Uri.
- abstract def path(path: String): Uri
Returns a copy of this instance with a new path.
- abstract def path(): String
Returns a String representation of the path of this Uri.
- abstract def pathSegments(): Iterable[String]
Returns the path segments of this Uri as an Iterable.
- abstract def port(port: Int): Uri
Returns a copy of this instance with a new port.
- abstract def port(): Int
Returns the port of this Uri.
- abstract def query(query: Query): Uri
Returns a copy of this instance with a new query.
- abstract def query(charset: Charset, mode: ParsingMode): Query
Returns the parsed Query instance of this Uri using the given charset and parsing mode.
- abstract def query(): Query
Returns the parsed Query instance of this Uri.
- abstract def queryString(charset: Charset): Optional[String]
Returns a decoded String representation of the query of this Uri.
- 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.
- 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.
- abstract def rawQueryString(): Optional[String]
Returns an undecoded String representation of the query of this Uri.
- abstract def scheme(scheme: String): Uri
Returns a copy of this instance with a new scheme.
- abstract def scheme(): String
Returns the scheme of this Uri.
- abstract def toRelative(): Uri
Returns a copy of this instance that is relative.
- abstract def userInfo(userInfo: String): Uri
Returns a copy of this instance with new user-info.
- abstract def userInfo(): String
Returns the user-info of this Uri.