A-index

A B C D E F G H I J L M N O P R S T U V W X Z

A

AbsoluteUrl - class in org.readium.r2.shared.util

Represents an absolute Uniform Resource Locator.

AbsoluteUrl.Companion - class in org.readium.r2.shared.util.AbsoluteUrl

AbstractUnicodeExtraField - class in org.readium.r2.shared.util.zip.compress.archivers.zip

A common base class for Unicode extra information extra fields.

accept(int) - function in org.readium.r2.shared.util.zip.compress.utils.ByteUtils.ByteConsumer

The contract is similar to write,consume the lower eight bytes of the int as a byte.

accept(int) - function in org.readium.r2.shared.util.zip.compress.utils.ByteUtils.OutputStreamByteConsumer

The contract is similar to write,consume the lower eight bytes of the int as a byte.

accept(int) - function in org.readium.r2.shared.util.zip.compress.utils.ByteUtils.OutputStreamByteConsumer

The contract is similar to write,consume the lower eight bytes of the int as a byte.

AccessError - class in org.readium.r2.shared.util.data

Marker interface for source-specific access errors.

Accessibility - class in org.readium.r2.shared.publication

Holds the accessibility metadata of a Publication.

Accessibility.AccessMode - class in org.readium.r2.shared.publication.Accessibility

A human sensory perceptual system or cognitive faculty through which a person may process or perceive information.

Accessibility.AccessMode.Companion - class in org.readium.r2.shared.publication.Accessibility.AccessMode

Accessibility.Certification - class in org.readium.r2.shared.publication.Accessibility

Certification of accessible publications.

Accessibility.Certification.Companion - class in org.readium.r2.shared.publication.Accessibility.Certification

Accessibility.Companion - class in org.readium.r2.shared.publication.Accessibility

Accessibility.Feature - class in org.readium.r2.shared.publication.Accessibility

A content feature of the described resource, such as accessible media, alternatives and supported enhancements for accessibility.

Accessibility.Feature.Companion - class in org.readium.r2.shared.publication.Accessibility.Feature

Accessibility.Hazard - class in org.readium.r2.shared.publication.Accessibility

A characteristic of the described resource that is physiologically dangerous to some users.

Accessibility.Hazard.Companion - class in org.readium.r2.shared.publication.Accessibility.Hazard

Accessibility.PrimaryAccessMode - class in org.readium.r2.shared.publication.Accessibility

A human primary sensory perceptual system or cognitive faculty through which a person may process or perceive information.

Accessibility.PrimaryAccessMode.Companion - class in org.readium.r2.shared.publication.Accessibility.PrimaryAccessMode

Accessibility.Profile - class in org.readium.r2.shared.publication.Accessibility

Accessibility profile.

Accessibility.Profile.Companion - class in org.readium.r2.shared.publication.Accessibility.Profile

Acquisition - class in org.readium.r2.shared.opds

OPDS Acquisition Object.

Acquisition.Companion - class in org.readium.r2.shared.opds.Acquisition

AcquisitionKt - class in org.readium.r2.shared.opds

add(Map) - function in org.readium.r2.shared.publication.Properties

Makes a copy of this Properties after merging in the given additional other properties.

add(Properties) - function in org.readium.r2.shared.publication.Properties

Makes a copy of this Properties after merging in the given additional other properties.

addArchiveEntry(ZipArchiveEntryRequest) - function in org.readium.r2.shared.util.zip.compress.archivers.zip.ScatterZipOutputStream

Add an archive entry to this scatter stream.

addAsFirstExtraField(ZipExtraField) - function in org.readium.r2.shared.util.zip.compress.archivers.zip.ZipArchiveEntry

Adds an extra field - replacing an already present extra fieldof the same type.

addExtraField(ZipExtraField) - function in org.readium.r2.shared.util.zip.compress.archivers.zip.ZipArchiveEntry

Adds an extra field - replacing an already present extra fieldof the same type.

addFileExtension(String) - function in org.readium.r2.shared.util.format.FormatHints

Returns a new FormatHints after appending the given fileExtension hint.

addHeader(String,String) - function in org.readium.r2.shared.util.http.HttpRequest.Builder

Adds value to header values associated with key.

addPrefix(String,CharSequence) - function in org.readium.r2.shared.extensions.StringKt

If this string starts with the given prefix, returns this string.

addProperties(Map) - function in org.readium.r2.shared.publication.Link

Makes a copy of this Link after merging in the given additional other properties.

addRawArchiveEntry(ZipArchiveEntry,InputStream) - function in org.readium.r2.shared.util.zip.compress.archivers.zip.ZipArchiveOutputStream

Adds an archive entry with a raw input stream.If crc, size and compressed size are supplied on the entry, these values will be used as-is.Zip64 status is re-established based on the settings in this stream, and the supplied valueis ignored.The entry is put and closed immediately.

addSelfLink(String,URL) - function in org.readium.r2.shared.publication.Publication

addSuffix(String,CharSequence) - function in org.readium.r2.shared.extensions.StringKt

If this string ends with the given suffix, returns this string.

addSuppressed(Throwable) - function in kotlin.UserException

addSuppressed(Throwable) - function in java.lang.AsynchronousCloseException

addSuppressed(Throwable) - function in java.lang.ClosedChannelException

addSuppressed(Throwable) - function in java.lang.ClosedByInterruptException

addSuppressed(Throwable) - function in java.lang.NonReadableChannelException

addSuppressed(Throwable) - function in java.lang.NonWritableChannelException

addSuppressed(Throwable) - function in java.lang.Zip64RequiredException

addSuppressed(Throwable) - function in java.lang.UnsupportedZipFeatureException

addSuppressed(Throwable) - function in kotlin.ErrorException

addSuppressed(Throwable) - function in kotlin.ReadException

adjustToLong(int) - function in org.readium.r2.shared.util.zip.compress.archivers.zip.ZipUtil

Assumes a negative integer really is a positive integer thathas wrapped around and re-creates the original value.

AES_ENCRYPTED - enum entry in org.readium.r2.shared.util.zip.compress.archivers.zip.ZipMethod

Compression Method 99 for AES encryption.

allMatchMediaType(List,MediaType) - function in org.readium.r2.shared.publication.LinkKt

Returns whether all the resources in the collection are matching the given media type.

allMatchMediaTypes(List,List) - function in org.readium.r2.shared.publication.LinkKt

Returns whether all the resources in the collection are matching any of the given media types.

allNamed(String) - function in org.readium.r2.shared.util.Url.Query

Returns all the values for the parameter with the given name.

allowMethodChange() - function in org.readium.r2.shared.util.zip.compress.archivers.zip.ResourceAlignmentExtraField

Indicates whether method change is allowed when re-compressing the ZIP file.

Always - enum entry in org.readium.r2.shared.util.zip.compress.archivers.zip.Zip64Mode

Use Zip64 extensions for all entries, even if it is clear it isnot required.

AlwaysWithCompatibility - enum entry in org.readium.r2.shared.util.zip.compress.archivers.zip.Zip64Mode

Always use Zip64 extensions for LFH and central directory as Always did, and at the meantime encodethe relative offset of LFH and disk number start as needed inCFH as AsNeeded did.

This is a compromise for some libraries including 7z andExpand-Archive Powershell utility(and likely Excel).

appendQueryParameter(String,String) - function in org.readium.r2.shared.util.http.HttpRequest.Builder

appendQueryParameters(Map) - function in org.readium.r2.shared.util.http.HttpRequest.Builder

appendToFilename(FileExtension,String) - function in org.readium.r2.shared.util.UrlKt

Appends this file extension to filename.

ArchiveEntry - class in org.readium.r2.shared.util.zip.compress.archivers

Represents an entry of an archive.

ArchiveInputStream - class in org.readium.r2.shared.util.zip.compress.archivers

Archive input streams MUST override the read - or read - method so that reading from the stream generates EOF for the end of data in each entry as well as at the end of the file proper.

ArchiveOpener - class in org.readium.r2.shared.util.archive

A factory to create Containers from archive Resources.

ArchiveOpener.OpenError - class in org.readium.r2.shared.util.archive.ArchiveOpener

ArchiveOpener.OpenError.FormatNotSupported - class in org.readium.r2.shared.util.archive.ArchiveOpener.OpenError

ArchiveOpener.OpenError.Reading - class in org.readium.r2.shared.util.archive.ArchiveOpener.OpenError

ArchiveOpener.SniffOpenError - class in org.readium.r2.shared.util.archive.ArchiveOpener

ArchiveOpener.SniffOpenError.NotRecognized - class in org.readium.r2.shared.util.archive.ArchiveOpener.SniffOpenError

ArchiveOpener.SniffOpenError.Reading - class in org.readium.r2.shared.util.archive.ArchiveOpener.SniffOpenError

ArchiveOutputStream - class in org.readium.r2.shared.util.zip.compress.archivers

Archive output stream implementations are expected to override the write method to improve performance.

ArchiveProperties - class in org.readium.r2.shared.publication.archive

ArchiveProperties - class in org.readium.r2.shared.util.archive

Holds information about how the resource is stored in the archive.

ArchiveProperties.Companion - class in org.readium.r2.shared.util.archive.ArchiveProperties

ArchivePropertiesKt - class in org.readium.r2.shared.util.archive

ArchiveSniffer - class in org.readium.r2.shared.util.format

Sniffs a simple Archive-based publication format, like Comic Book Archive or Zipped Audio Book.

asComponentCallbacks2(MemoryObserver) - function in org.readium.r2.shared.util.MemoryObserver.Companion

Wraps the given observer into a ComponentCallbacks2 usable with Android's Context.

asInputStream(Readable,LongRange,Function1) - function in org.readium.r2.shared.util.data.InputStreamKt

Wraps a Readable into an InputStream.

AsNeeded - enum entry in org.readium.r2.shared.util.zip.compress.archivers.zip.Zip64Mode

Use Zip64 extensions for all entries where they are required,don't use them for entries that clearly don't require them.

Asset - class in org.readium.r2.shared.util.asset

An asset which is either a single resource or a container that holds multiple resources.

AssetRetriever - class in org.readium.r2.shared.util.asset

Retrieves an Asset instance providing reading access to the resource(s) of an asset stored at a given Url as well as its Format.

AssetRetriever.RetrieveError - class in org.readium.r2.shared.util.asset.AssetRetriever

Error while trying to retrieve an asset from a Resource or a Container.

AssetRetriever.RetrieveError.FormatNotSupported - class in org.readium.r2.shared.util.asset.AssetRetriever.RetrieveError

The format of the resource is not recognized.

AssetRetriever.RetrieveError.Reading - class in org.readium.r2.shared.util.asset.AssetRetriever.RetrieveError

An error occurred when trying to read the asset.

AssetRetriever.RetrieveUrlError - class in org.readium.r2.shared.util.asset.AssetRetriever

Error while trying to retrieve an asset from an URL.

AssetRetriever.RetrieveUrlError.FormatNotSupported - class in org.readium.r2.shared.util.asset.AssetRetriever.RetrieveUrlError

The format of the resource at the requested Url is not recognized.

AssetRetriever.RetrieveUrlError.Reading - class in org.readium.r2.shared.util.asset.AssetRetriever.RetrieveUrlError

An error occurred when trying to read the asset.

AssetRetriever.RetrieveUrlError.SchemeNotSupported - class in org.readium.r2.shared.util.asset.AssetRetriever.RetrieveUrlError

The scheme (e.g.

async(SuspendFunction0) - function in org.readium.r2.shared.util.CoroutineQueue

Creates a coroutine in the queue and returns its future result as an implementation of Deferred.

AsynchronousCloseException - class in org.readium.r2.shared.util.zip.jvm

An {@code AsynchronousCloseException} is thrown when the underlying channel for an I/O operation is closed by another thread.

attribute(Content.AttributeKey) - function in org.readium.r2.shared.publication.services.content.Content.Element