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

CursorList

class CursorList<E>(list: List<E> = emptyList(), index: Int = -1) : List<E>

A List with a mutable cursor index.

next and previous refer to the last element returned by a previous call to any of both methods.

Parameters

list

the content of the CursorList

index

the index of the element that will initially be considered as the last returned element. May be -1 or the size of the list as well.

Constructors

CursorList

constructor(list: List<E> = emptyList(), index: Int = -1)

Properties

allAreAudio

val List<Link>.allAreAudio: Boolean

Returns whether all the resources in the collection are audio clips.

allAreBitmap

val List<Link>.allAreBitmap: Boolean

Returns whether all the resources in the collection are bitmaps.

allAreHtml

val List<Link>.allAreHtml: Boolean

Returns whether all the resources in the collection are HTML documents.

allAreVideo

val List<Link>.allAreVideo: Boolean

Returns whether all the resources in the collection are video clips.

size

open override val size: Int

Functions

allMatchMediaType

fun List<Link>.allMatchMediaType(mediaType: MediaType): Boolean

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

allMatchMediaTypes

fun List<Link>.allMatchMediaTypes(mediaTypes: List<MediaType>): Boolean

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

contains

open operator override fun contains(element: E): Boolean

containsAll

open override fun containsAll(elements: Collection<E>): Boolean

copy

@JvmName(name = "copyContributors")

fun List<Contributor>.copy(transformer: ManifestTransformer): List<Contributor>

@JvmName(name = "copyLinks")

fun List<Link>.copy(transformer: ManifestTransformer): List<Link>

@JvmName(name = "copySubjects")

fun List<Subject>.copy(transformer: ManifestTransformer): List<Subject>

filterByMediaType

fun List<Link>.filterByMediaType(mediaType: MediaType): List<Link>

Finds all the links matching the given media type.

filterByMediaTypes

fun List<Link>.filterByMediaTypes(mediaTypes: List<MediaType>): List<Link>

Finds all the links matching any of the given media types.

filterByRel

fun List<Link>.filterByRel(rel: String): List<Link>

Finds all the links with the given relation.

firstWithHref

fun List<Link>.firstWithHref(href: Url): Link?

Finds the first Link with the given href, or null if not found.

firstWithMediaType

fun List<Link>.firstWithMediaType(mediaType: MediaType): Link?

Finds the first link matching the given media type.

firstWithRel

fun List<Link>.firstWithRel(rel: String): Link?

Finds the first link with the given relation.

flatten

fun List<Link>.flatten(): List<Link>

Returns a list of Link after flattening the children and alternates links of the receiver.

get

open operator override fun get(index: Int): E

hasNext

fun hasNext(): Boolean

hasPrevious

fun hasPrevious(): Boolean

indexOf

open override fun indexOf(element: E): Int

indexOfFirstWithHref

fun List<Link>.indexOfFirstWithHref(href: Url): Int?

Returns the index of the first Link with the given href, or null if not found.

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Iterator<E>

lastIndexOf

open override fun lastIndexOf(element: E): Int

listIterator

open override fun listIterator(): ListIterator<E>

open override fun listIterator(index: Int): ListIterator<E>

fun next(): E?

Moves the cursor forward and returns the element, or null when reaching the end.

fun previous(): E?

Moves the cursor backward and returns the element, or null when reaching the beginning.

subList

open override fun subList(fromIndex: Int, toIndex: Int): List<E>

toJSON

fun List<JSONable>.toJSON(): JSONArray

Serializes a list of JSONable into a JSONArray.

toLinks

fun List<PdfDocument.OutlineNode>.toLinks(documentHref: Url): List<Link>

Converts a PDF outline to Link objects.