object Empty extends Uri
- Source
- Uri.scala
- Alphabetic
- By Inheritance
- Empty
- Uri
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val authority: Authority
- Definition Classes
- Uri
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def copy(scheme: String = scheme, authority: Authority = authority, path: Path = path, rawQueryString: Option[String] = rawQueryString, fragment: Option[String] = fragment): Uri
Returns a copy of this Uri with the given components.
Returns a copy of this Uri with the given components.
If you want to use the copy constructor to update the 'rawQueryString', it is up to you to make sure the query string does not contain invalid characters. For this reason we recommend using Uri#withRawQueryString() instead.
- Definition Classes
- Uri
- def effectivePort: Int
The effective port of this Uri given the currently set authority and scheme values.
The effective port of this Uri given the currently set authority and scheme values. If the authority has an explicitly set port (i.e. a non-zero port value) then this port is the effective port. Otherwise the default port for the current scheme is returned.
- Definition Classes
- Uri
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val fragment: Option[String]
- Definition Classes
- Uri
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def isAbsolute: Boolean
- Definition Classes
- Uri
- def isEmpty: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isRelative: Boolean
- Definition Classes
- Uri
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val path: Path
- Definition Classes
- Uri
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def query(charset: Charset = UTF8, mode: ParsingMode = Uri.ParsingMode.Relaxed): Query
Parses the rawQueryString member into a Query instance.
Parses the rawQueryString member into a Query instance.
- Definition Classes
- Uri
- def queryString(charset: Charset = UTF8): Option[String]
Returns the query part of the Uri in its decoded form.
Returns the query part of the Uri in its decoded form.
- Definition Classes
- Uri
- val rawQueryString: Option[String]
- Definition Classes
- Uri
- def resolvedAgainst(base: Uri): Uri
Returns a new absolute Uri that is the result of the resolution process defined by http://tools.ietf.org/html/rfc3986#section-5.2.2 The given base Uri must be absolute.
Returns a new absolute Uri that is the result of the resolution process defined by http://tools.ietf.org/html/rfc3986#section-5.2.2 The given base Uri must be absolute.
- Definition Classes
- Uri
- val scheme: String
- Definition Classes
- Uri
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toEffectiveHttpRequestUri(hostHeaderHost: Host, hostHeaderPort: Int, securedConnection: Boolean = false, defaultAuthority: Authority = Authority.Empty): Uri
Converts this URI to an "effective HTTP request URI" as defined by http://tools.ietf.org/html/rfc7230#section-5.5
Converts this URI to an "effective HTTP request URI" as defined by http://tools.ietf.org/html/rfc7230#section-5.5
- Definition Classes
- Uri
- def toEffectiveRequestUri(hostHeaderHost: Host, hostHeaderPort: Int, defaultScheme: String, defaultAuthority: Authority = Authority.Empty): Uri
Converts this URI to an "effective request URI" as defined by http://tools.ietf.org/html/rfc7230#section-5.5
Converts this URI to an "effective request URI" as defined by http://tools.ietf.org/html/rfc7230#section-5.5
- Definition Classes
- Uri
- def toHttpRequestTargetOriginForm: Uri
Converts this URI into an HTTP request target "origin-form" as defined by https://tools.ietf.org/html/rfc7230#section-5.3.
Converts this URI into an HTTP request target "origin-form" as defined by https://tools.ietf.org/html/rfc7230#section-5.3.
Note that the resulting URI instance is not a valid RFC 3986 URI! (As it might be a "relative" URI with a part component starting with a double slash.)
- Definition Classes
- Uri
- def toRelative: Uri
Converts this URI into a relative URI by keeping the path, query and fragment, but dropping the scheme and authority.
Converts this URI into a relative URI by keeping the path, query and fragment, but dropping the scheme and authority.
- Definition Classes
- Uri
- def toString(): String
- Definition Classes
- Uri → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withAuthority(host: String, port: Int): Uri
Returns a copy of this Uri with a Authority created using the given host and port.
Returns a copy of this Uri with a Authority created using the given host and port.
- Definition Classes
- Uri
- def withAuthority(host: Host, port: Int, userinfo: String = ""): Uri
Returns a copy of this Uri with a Authority created using the given host, port and userinfo.
Returns a copy of this Uri with a Authority created using the given host, port and userinfo.
- Definition Classes
- Uri
- def withAuthority(authority: Authority): Uri
Returns a copy of this Uri with the given authority.
Returns a copy of this Uri with the given authority.
- Definition Classes
- Uri
- def withFragment(fragment: String): Uri
Returns a copy of this Uri with the given fragment.
Returns a copy of this Uri with the given fragment.
- Definition Classes
- Uri
- def withHost(host: String): Uri
Returns a copy of this Uri with the given host.
Returns a copy of this Uri with the given host.
- Definition Classes
- Uri
- def withHost(host: Host): Uri
Returns a copy of this Uri with the given host.
Returns a copy of this Uri with the given host.
- Definition Classes
- Uri
- def withPath(path: Path): Uri
Returns a copy of this Uri with the given path.
Returns a copy of this Uri with the given path.
- Definition Classes
- Uri
- def withPort(port: Int): Uri
Returns a copy of this Uri with the given port.
Returns a copy of this Uri with the given port.
- Definition Classes
- Uri
- def withQuery(query: Query): Uri
Returns a copy of this Uri with the given query.
Returns a copy of this Uri with the given query.
- Definition Classes
- Uri
- def withRawQueryString(rawQueryString: String, mode: ParsingMode): Uri
Returns a copy of this Uri with the given query string.
Returns a copy of this Uri with the given query string.
Characters that are not within the range described at https://tools.ietf.org/html/rfc3986#section-3.4 must 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.
- mode
depending on the mode, characters outside of the range allowed by RFC3986 will either cause an
IllegalUriException
or be automatically percent-encoded. Be aware that relying on automatic percent-encoding is usually a programming error.
- Definition Classes
- Uri
- def withRawQueryString(rawQuery: String): Uri
Returns a copy of this Uri with the given query string.
Returns a copy of this Uri with the given query string.
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 a 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.
- Definition Classes
- Uri
- def withScheme(scheme: String): Uri
Returns a copy of this Uri with the given scheme.
Returns a copy of this Uri with the given scheme. The
scheme
change of the Uri has the following effect on the port value:- If the Uri has a non-default port for the scheme before the change this port will remain unchanged.
- If the Uri has the default port for the scheme before the change it will have the default port for the new scheme after the change.
- Definition Classes
- Uri
- def withUserInfo(userinfo: String): Uri
Returns a copy of this Uri with the given userinfo.
Returns a copy of this Uri with the given userinfo.
- Definition Classes
- Uri
- def withoutFragment: Uri
Drops the fragment from this URI
Drops the fragment from this URI
- Definition Classes
- Uri