readium-shared/org.readium.r2.shared.util/Url

Url

sealed class Url : Parcelable

A Uniform Resource Locator.

https://url.spec.whatwg.org/

Inheritors

AbsoluteUrl

RelativeUrl

Types

Companion

object Companion

Query

data class Query(val parameters: List<Url.QueryParameter>)

Represents a list of query parameters in a URL.

QueryParameter

data class QueryParameter(val name: String, val value: String?)

Represents a single query parameter and its value in a URL.

Scheme

@JvmInline

value class Scheme

A URL scheme, e.g. http or file.

Properties

extension

val extension: FileExtension?

Extension of the filename portion of the URL path.

filename

val filename: String?

Decoded filename portion of the URL path.

fragment

val fragment: String?

Returns the decoded fragment present in this URL, if any.

path

val path: String?

Decoded path segments identifying a location.

query

val query: Url.Query

Returns the decoded query parameters present in this URL, in the order they appear.

Functions

describeContents

abstract fun describeContents(): Int

equals

open operator override fun equals(other: Any?): Boolean

Returns whether two URLs are strictly equal, by comparing their string representation.

hashCode

open override fun hashCode(): Int

isEquivalent

fun isEquivalent(url: Url?): Boolean

Returns whether the receiver is equivalent to the given url after normalization.

isEquivalent

fun Url?.isEquivalent(url: Url?): Boolean

Returns whether the receiver is equivalent to the given url after normalization.

normalize

open fun normalize(): Url

Normalizes the URL using a subset of the RFC-3986 rules.

relativize

open fun relativize(url: Url): Url

Relativizes the given url against this URL.

removeFragment

fun removeFragment(): Url

Returns a copy of this URL after dropping its fragment.

removeQuery

fun removeQuery(): Url

Returns a copy of this URL after dropping its query.

resolve

open fun resolve(url: Url): Url

Resolves the given url to this URL.

toString

open override fun toString(): String

toUri

fun Url.toUri(): Uri

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)