epub4kmp-core/io.documentnode.epub4kmp.domain/Resources

Resources

class Resources(source)

All the resources that make up the book. XHTML files, images and epub xml documents must be here.

Constructors

Resources

constructor()

Types

Companion

object Companion

Properties

all

val all: Collection<Resource>

allHrefs

val allHrefs: List<String>

isEmpty

val isEmpty: Boolean

resourceMap

val resourceMap: Map<String?, Resource>

size

val size: Int

The number of resources

Functions

add

fun add(resource: Resource): Resource

Adds a resource to the resources.

addAll

fun addAll(resources: Collection<Resource>)

Adds all resources from the given Collection of resources to the existing collection.

containsByHref

fun containsByHref(href: String?): Boolean

Whether there exists a resource with the given href

findFirstResourceByMediaType

fun findFirstResourceByMediaType(mediaType: MediaType): Resource?

Gets the first resource (random order) with the give mediatype.

fixResourceId

fun fixResourceId(resource: Resource)

Checks the id of the given resource and changes to a unique identifier if it isn't one already.

getByHref

fun getByHref(href: String): Resource?

Gets the resource with the given href. If the given href contains a fragmentId then that fragment id will be ignored.

getById

fun getById(id: String): Resource?

Gets the resource with the given id.

getByIdOrHref

fun getByIdOrHref(idOrHref: String): Resource?

First tries to find a resource with as id the given idOrHref, if that fails it tries to find one with the idOrHref as href.

getResourcesByMediaType

fun getResourcesByMediaType(mediaType: MediaType): List<Resource>

All resources that have the given MediaType.

getResourcesByMediaTypes

fun getResourcesByMediaTypes(mediaTypes: Array<MediaType>): List<Resource>

All Resources that match any of the given list of MediaTypes

remove

fun remove(href: String?): Resource?

Remove the resource with the given href.

set

fun set(resources: Collection<Resource>)

fun set(resources: Map<String?, Resource>)

Sets the collection of Resources to the given collection of resources