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

A

ACKNOWLEDGEMENTS - Static variable in class nl.siegmann.epublib.domain.GuideReference

add(Resource) - Method in class nl.siegmann.epublib.domain.Resources

Adds a resource to the resources.

addAll(Collection<Resource>) - Method in class nl.siegmann.epublib.domain.Resources

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

addAuthor(Author) - Method in class nl.siegmann.epublib.domain.Metadata

addBookProcessor(BookProcessor) - Method in class nl.siegmann.epublib.epub.BookProcessorPipeline

addChildSection(TOCReference) - Method in class nl.siegmann.epublib.domain.TOCReference

addContributor(Author) - Method in class nl.siegmann.epublib.domain.Metadata

addDate(Date) - Method in class nl.siegmann.epublib.domain.Metadata

addDescription(String) - Method in class nl.siegmann.epublib.domain.Metadata

addIdentifier(Identifier) - Method in class nl.siegmann.epublib.domain.Metadata

addLocation(Resource) - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

addLocation(NavigationHistory.Location) - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

Adds the location after the current position.

addLocation(String) - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

addNavigationEventListener(NavigationEventListener) - Method in class nl.siegmann.epublib.browsersupport.Navigator

addPublisher(String) - Method in class nl.siegmann.epublib.domain.Metadata

addReference(GuideReference) - Method in class nl.siegmann.epublib.domain.Guide

addResource(Resource) - Method in class nl.siegmann.epublib.domain.Book

addResource(Resource) - Method in class nl.siegmann.epublib.domain.Spine

Adds the given resource to the spine references and returns it.

addResource(Resource, String) - Method in class nl.siegmann.epublib.domain.TableOfContents

Calls addTOCReferenceAtLocation after splitting the path using the DEFAULT_PATH_SEPARATOR.

addResource(Resource, String, String) - Method in class nl.siegmann.epublib.domain.TableOfContents

Calls addTOCReferenceAtLocation after splitting the path using the given pathSeparator.

addSection(TOCReference, String, Resource) - Method in class nl.siegmann.epublib.domain.Book

Adds the resource to the table of contents of the book as a child section of the given parentSection

addSection(String, Resource) - Method in class nl.siegmann.epublib.domain.Book

Adds a resource to the book's set of resources, table of contents and if there is no resource with the id in the spine also adds it to the spine.

addSpineReference(SpineReference) - Method in class nl.siegmann.epublib.domain.Spine

Adds the given spineReference to the spine references and returns it.

addTitle(String) - Method in class nl.siegmann.epublib.domain.Metadata

addTOCReference(Resource, String[]) - Method in class nl.siegmann.epublib.domain.TableOfContents

Adds the given Resources to the TableOfContents at the location specified by the pathElements.

addTOCReference(Resource, int[], String, String) - Method in class nl.siegmann.epublib.domain.TableOfContents

Adds the given Resources to the TableOfContents at the location specified by the pathElements.

addTOCReference(TOCReference) - Method in class nl.siegmann.epublib.domain.TableOfContents

addType(String) - Method in class nl.siegmann.epublib.domain.Metadata

afterRead(int) - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invoked by the read methods after the proxied call has returned successfully.

Author - Class in nl.siegmann.epublib.domain

Represents one of the authors of the book

Author(String) - Constructor for class nl.siegmann.epublib.domain.Author

Author(String, String) - Constructor for class nl.siegmann.epublib.domain.Author

available() - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invokes the delegate's available() method.

B

beforeRead(int) - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invoked by the read methods before the call is proxied.

BIBLIOGRAPHY - Static variable in class nl.siegmann.epublib.domain.GuideReference

BOMInputStream - Class in nl.siegmann.epublib.util.commons.io

This class is used to wrap a stream that includes an encoded ByteOrderMark as its first bytes.

BOMInputStream(InputStream) - Constructor for class nl.siegmann.epublib.util.commons.io.BOMInputStream

Constructs a new BOM InputStream that excludes a ByteOrderMark.UTF_8 BOM.

BOMInputStream(InputStream, boolean) - Constructor for class nl.siegmann.epublib.util.commons.io.BOMInputStream

Constructs a new BOM InputStream that detects a a ByteOrderMark.UTF_8 and optionally includes it.

BOMInputStream(InputStream, ByteOrderMark...) - Constructor for class nl.siegmann.epublib.util.commons.io.BOMInputStream

Constructs a new BOM InputStream that excludes the specified BOMs.

BOMInputStream(InputStream, boolean, ByteOrderMark...) - Constructor for class nl.siegmann.epublib.util.commons.io.BOMInputStream

Constructs a new BOM InputStream that detects the specified BOMs and optionally includes them.

Book - Class in nl.siegmann.epublib.domain

Representation of a Book.

Book() - Constructor for class nl.siegmann.epublib.domain.Book

BOOK_ID_ID - Static variable in class nl.siegmann.epublib.epub.PackageDocumentBase

BookProcessor - Interface in nl.siegmann.epublib.epub

Post-processes a book.

BookProcessorPipeline - Class in nl.siegmann.epublib.epub

A book processor that combines several other bookprocessors Fixes coverpage/coverimage.

BookProcessorPipeline() - Constructor for class nl.siegmann.epublib.epub.BookProcessorPipeline

BookProcessorPipeline(List<BookProcessor>) - Constructor for class nl.siegmann.epublib.epub.BookProcessorPipeline

byCode(String) - Static method in enum nl.siegmann.epublib.domain.Relator

ByteOrderMark - Class in nl.siegmann.epublib.util.commons.io

Byte Order Mark (BOM) representation - see org.apache.commons.io.input.BOMInputStream.

ByteOrderMark(String, int...) - Constructor for class nl.siegmann.epublib.util.commons.io.ByteOrderMark

Construct a new BOM.

C

calcNewNrReadSize(int, int) - Static method in class nl.siegmann.epublib.util.IOUtil

if totalNrRead < 0 then totalNrRead is returned, if (nrRead + totalNrRead) < Integer.MAX_VALUE then nrRead + totalNrRead is returned, -1 otherwise.

calculateDepth() - Method in class nl.siegmann.epublib.domain.TableOfContents

close() - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invokes the delegate's close() method.

close() - Method in class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Closes the XmlStreamReader stream.

close() - Method in class nl.siegmann.epublib.util.NoCloseOutputStream

A close() that does not call it's parent's close()

close() - Method in class nl.siegmann.epublib.util.NoCloseWriter

close() - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

collapsePathDots(String) - Static method in class nl.siegmann.epublib.util.StringUtil

Changes a path containing '

CollectionUtil - Class in nl.siegmann.epublib.util

CollectionUtil() - Constructor for class nl.siegmann.epublib.util.CollectionUtil

COLOPHON - Static variable in class nl.siegmann.epublib.domain.GuideReference

Constants - Interface in nl.siegmann.epublib

containsByHref(String) - Method in class nl.siegmann.epublib.domain.Resources

Whether there exists a resource with the given href

containsId(String) - Method in class nl.siegmann.epublib.domain.Resources

content - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

contributor - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

copy(InputStream, OutputStream) - Static method in class nl.siegmann.epublib.util.IOUtil

Copies the contents of the InputStream to the OutputStream.

copy(Reader, Writer) - Static method in class nl.siegmann.epublib.util.IOUtil

Copies the contents of the Reader to the Writer.

COPYRIGHT_PAGE - Static variable in class nl.siegmann.epublib.domain.GuideReference

COVER - Static variable in class nl.siegmann.epublib.domain.GuideReference

the book cover(s), jacket information, etc.

coverage - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

createDocumentBuilder() - Static method in class nl.siegmann.epublib.epub.EpubProcessorSupport

Creates a DocumentBuilder that looks up dtd's and schema's from epublib's classpath.

createNCXResource(Book) - Static method in class nl.siegmann.epublib.epub.NCXDocument

createNCXResource(List<Identifier>, String, List<Author>, TableOfContents) - Static method in class nl.siegmann.epublib.epub.NCXDocument

createResource(File) - Static method in class nl.siegmann.epublib.util.ResourceUtil

createResource(String, String) - Static method in class nl.siegmann.epublib.util.ResourceUtil

Creates a resource with as contents a html page with the given title.

createResource(ZipEntry, ZipInputStream) - Static method in class nl.siegmann.epublib.util.ResourceUtil

Creates a resource out of the given zipEntry and zipInputStream.

createSpineReferences(Collection<Resource>) - Static method in class nl.siegmann.epublib.domain.Spine

createXmlSerializer(OutputStream) - Static method in class nl.siegmann.epublib.epub.EpubProcessorSupport

creator - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

CSS - Static variable in class nl.siegmann.epublib.service.MediatypeService

D

Date - Class in nl.siegmann.epublib.domain

A Date used by the book's metadata.

Date(Date) - Constructor for class nl.siegmann.epublib.domain.Date

Date(String) - Constructor for class nl.siegmann.epublib.domain.Date

Date(Date, Date.Event) - Constructor for class nl.siegmann.epublib.domain.Date

Date(String, Date.Event) - Constructor for class nl.siegmann.epublib.domain.Date

Date(Date, String) - Constructor for class nl.siegmann.epublib.domain.Date

Date(String, String) - Constructor for class nl.siegmann.epublib.domain.Date

date - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

Date.Event - Enum in nl.siegmann.epublib.domain

dateFormat - Static variable in class nl.siegmann.epublib.epub.PackageDocumentBase

DEDICATION - Static variable in class nl.siegmann.epublib.domain.GuideReference

DEFAULT_COVER_TITLE - Static variable in class nl.siegmann.epublib.domain.Guide

DEFAULT_LANGUAGE - Static variable in class nl.siegmann.epublib.domain.Metadata

DEFAULT_MAX_HISTORY_SIZE - Static variable in class nl.siegmann.epublib.browsersupport.NavigationHistory

DEFAULT_NCX_HREF - Static variable in class nl.siegmann.epublib.epub.NCXDocument

DEFAULT_PATH_SEPARATOR - Static variable in class nl.siegmann.epublib.domain.TableOfContents

DEFAULT_TOC_ID - Static variable in interface nl.siegmann.epublib.Constants

defaultIfNull(String) - Static method in class nl.siegmann.epublib.util.StringUtil

If the given text is null return "", the original text otherwise.

defaultIfNull(String, String) - Static method in class nl.siegmann.epublib.util.StringUtil

If the given text is null return "", the given defaultValue otherwise.

description - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

determineMediaType(String) - Static method in class nl.siegmann.epublib.service.MediatypeService

Gets the MediaType based on the file extension.

documentBuilderFactory - Static variable in class nl.siegmann.epublib.epub.EpubProcessorSupport

DomUtil - Class in nl.siegmann.epublib.util

DomUtil() - Constructor for class nl.siegmann.epublib.util.DomUtil

E

ENCODING - Static variable in interface nl.siegmann.epublib.Constants

ENCODING_PATTERN - Static variable in class nl.siegmann.epublib.util.commons.io.XmlStreamReader

endsWithIgnoreCase(String, String) - Static method in class nl.siegmann.epublib.util.StringUtil

Whether the given source string ends with the given suffix, ignoring case.

EPIGRAPH - Static variable in class nl.siegmann.epublib.domain.GuideReference

an epigraph is a phrase, quotation, or poem that is set at the beginning of a document or component.

EPUB - Static variable in class nl.siegmann.epublib.service.MediatypeService

EPUBLIB_GENERATOR_NAME - Static variable in interface nl.siegmann.epublib.Constants

EpubProcessorSupport - Class in nl.siegmann.epublib.epub

Various low-level support methods for reading/writing epubs.

EpubProcessorSupport() - Constructor for class nl.siegmann.epublib.epub.EpubProcessorSupport

EpubReader - Class in nl.siegmann.epublib.epub

Reads an epub file.

EpubReader() - Constructor for class nl.siegmann.epublib.epub.EpubReader

EpubWriter - Class in nl.siegmann.epublib.epub

Generates an epub file.

EpubWriter() - Constructor for class nl.siegmann.epublib.epub.EpubWriter

EpubWriter(BookProcessor) - Constructor for class nl.siegmann.epublib.epub.EpubWriter

equals(Object) - Method in class nl.siegmann.epublib.domain.Author

equals(Object) - Method in class nl.siegmann.epublib.domain.Identifier

equals(Object) - Method in class nl.siegmann.epublib.domain.MediaType

equals(Object) - Method in class nl.siegmann.epublib.domain.Resource

equals(Object) - Method in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

Indicates if this BOM's bytes equals another.

equals(String, String) - Static method in class nl.siegmann.epublib.util.StringUtil

Null-safe string comparator

event - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

F

file_as - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

findFirstResourceById(String) - Method in class nl.siegmann.epublib.domain.Spine

Finds the first resource that has the given resourceId.

findFirstResourceByMediaType(MediaType) - Method in class nl.siegmann.epublib.domain.Resources

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

findFirstResourceByMediaType(Collection<Resource>, MediaType) - Static method in class nl.siegmann.epublib.domain.Resources

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

first(List<T>) - Static method in class nl.siegmann.epublib.util.CollectionUtil

fixResourceId(Resource) - Method in class nl.siegmann.epublib.domain.Resources

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

flush() - Method in class nl.siegmann.epublib.util.NoCloseWriter

flush() - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

FOREWORD - Static variable in class nl.siegmann.epublib.domain.GuideReference

format - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

FRAGMENT_SEPARATOR_CHAR - Static variable in interface nl.siegmann.epublib.Constants

fromValue(String) - Static method in enum nl.siegmann.epublib.domain.Date.Event

G

generateSpineFromTableOfContents() - Method in class nl.siegmann.epublib.domain.Book

generator - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFValues

get(int) - Method in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

The byte at the specified position.

getAll() - Method in class nl.siegmann.epublib.domain.Resources

getAllHrefs() - Method in class nl.siegmann.epublib.domain.Resources

getAllUniqueResources() - Method in class nl.siegmann.epublib.domain.TableOfContents

All unique references (unique by href) in the order in which they are referenced to in the table of contents.

getAsDocument(Resource) - Static method in class nl.siegmann.epublib.util.ResourceUtil

Reads parses the xml therein and returns the result as a Document

getAsDocument(Resource, DocumentBuilder) - Static method in class nl.siegmann.epublib.util.ResourceUtil

Reads the given resources inputstream, parses the xml therein and returns the result as a Document

getAuthors() - Method in class nl.siegmann.epublib.domain.Metadata

getBOM() - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Return the BOM (Byte Order Mark).

getBOMCharsetName() - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Return the BOM charset Name - ByteOrderMark.getCharsetName().

getBomEncoding() - Method in exception nl.siegmann.epublib.util.commons.io.XmlStreamReaderException

Returns the BOM encoding found in the InputStream.

getBook() - Method in class nl.siegmann.epublib.browsersupport.Navigator

getBookIdIdentifier(List<Identifier>) - Static method in class nl.siegmann.epublib.domain.Identifier

The first identifier for which the bookId is true is made the bookId identifier.

getBookProcessors() - Method in class nl.siegmann.epublib.epub.BookProcessorPipeline

getByHref(String) - Method in class nl.siegmann.epublib.domain.Resources

Gets the resource with the given href.

getById(String) - Method in class nl.siegmann.epublib.domain.Resources

Gets the resource with the given id.

getByIdOrHref(String) - Method in class nl.siegmann.epublib.domain.Resources

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.

getBytes() - Method in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

Return a copy of the BOM's bytes.

getCharsetName() - Method in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

Return the name of the Charset the BOM represents.

getChildren() - Method in class nl.siegmann.epublib.domain.TOCReference

getCode() - Method in enum nl.siegmann.epublib.domain.Relator

getComparatorByTitleIgnoreCase() - Static method in class nl.siegmann.epublib.domain.TOCReference

getCompleteHref() - Method in class nl.siegmann.epublib.domain.TitledResourceReference

If the fragmentId is blank it returns the resource href, otherwise it returns the resource href + '#' + the fragmentId.

getContents() - Method in class nl.siegmann.epublib.domain.Book

All Resources of the Book that can be reached via the Spine, the TableOfContents or the Guide.

getContentTypeEncoding() - Method in exception nl.siegmann.epublib.util.commons.io.XmlStreamReaderException

Returns the encoding in the content-type used to attempt determining the encoding.

getContentTypeMime() - Method in exception nl.siegmann.epublib.util.commons.io.XmlStreamReaderException

Returns the MIME type in the content-type used to attempt determining the encoding.

getContributors() - Method in class nl.siegmann.epublib.domain.Metadata

getCoverImage() - Method in class nl.siegmann.epublib.domain.Book

The book's cover image.

getCoverImage() - Method in class nl.siegmann.epublib.domain.Metadata

The main image used by the cover page.

getCoverPage() - Method in class nl.siegmann.epublib.domain.Book

The book's cover page.

getCoverPage() - Method in class nl.siegmann.epublib.domain.Guide

The coverpage of the book.

getCoverReference() - Method in class nl.siegmann.epublib.domain.Guide

getCurrentBook() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getCurrentFragmentId() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getCurrentFragmentId() - Method in class nl.siegmann.epublib.browsersupport.Navigator

getCurrentHref() - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

getCurrentPos() - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

getCurrentResource() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getCurrentResource() - Method in class nl.siegmann.epublib.browsersupport.Navigator

getCurrentSectionPos() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getCurrentSectionPos() - Method in class nl.siegmann.epublib.browsersupport.Navigator

getCurrentSize() - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

getCurrentSpinePos() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getCurrentSpinePos() - Method in class nl.siegmann.epublib.browsersupport.Navigator

The current position within the spine.

getData() - Method in class nl.siegmann.epublib.domain.Resource

getDates() - Method in class nl.siegmann.epublib.domain.Metadata

getDefaultEncoding() - Method in class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Returns the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on content-type are not adequate.

getDefaultExtension() - Method in class nl.siegmann.epublib.domain.MediaType

getDescriptions() - Method in class nl.siegmann.epublib.domain.Metadata

getDocumentBuilderFactory() - Method in class nl.siegmann.epublib.epub.EpubProcessorSupport

getEncoding() - Method in class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Returns the charset encoding of the XmlStreamReader.

getEvent() - Method in class nl.siegmann.epublib.domain.Date

getExtensions() - Method in class nl.siegmann.epublib.domain.MediaType

getFirstChildWithTagname(String, Node) - Static method in class nl.siegmann.epublib.util.DomUtil

getFirstname() - Method in class nl.siegmann.epublib.domain.Author

getFirstTitle() - Method in class nl.siegmann.epublib.domain.Metadata

Gets the first non-blank title of the book.

getFormat() - Method in class nl.siegmann.epublib.domain.Metadata

getFragmentId() - Method in class nl.siegmann.epublib.domain.TitledResourceReference

getGuide() - Method in class nl.siegmann.epublib.domain.Book

The guide; contains references to special sections of the book like colophon, glossary, etc.

getHistoryWaitTime() - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

If the time between a navigation event is less than the historyWaitTime then the new location is not added to the history.

getHref() - Method in class nl.siegmann.epublib.domain.Resource

The location of the resource within the contents folder of the epub file.

getHtmlProcessor() - Method in class nl.siegmann.epublib.epub.EpubWriter

getId() - Method in class nl.siegmann.epublib.domain.Resource

The resources Id.

getIdentifiers() - Method in class nl.siegmann.epublib.domain.Metadata

getInputEncoding() - Method in class nl.siegmann.epublib.domain.Resource

The encoding of the resource.

getInputSource(Resource) - Static method in class nl.siegmann.epublib.util.ResourceUtil

Gets the contents of the Resource as an InputSource in a null-safe manner.

getInputStream() - Method in class nl.siegmann.epublib.domain.Resource

getLanguage() - Method in class nl.siegmann.epublib.domain.Metadata

getLastname() - Method in class nl.siegmann.epublib.domain.Author

getMaxHistorySize() - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

getMediaType() - Method in class nl.siegmann.epublib.domain.Resource

This resource's mediaType.

getMediaTypeByName(String) - Static method in class nl.siegmann.epublib.service.MediatypeService

getMediatypeService() - Method in class nl.siegmann.epublib.epub.EpubWriter

getMetadata() - Method in class nl.siegmann.epublib.domain.Book

The Book's metadata (titles, authors, etc)

getName() - Method in class nl.siegmann.epublib.domain.MediaType

getName() - Method in enum nl.siegmann.epublib.domain.Relator

getNamespaceContext() - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

getNavigator() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getNcxResource() - Method in class nl.siegmann.epublib.domain.Book

getOldBook() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getOldFragmentId() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getOldResource() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getOldSectionPos() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

The previous position within the section.

getOldSpinePos() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

getOpfResource() - Method in class nl.siegmann.epublib.domain.Book

getOtherProperties() - Method in class nl.siegmann.epublib.domain.Metadata

Metadata properties not hard-coded like the author, title, etc.

getPrefix(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

getProperty(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

getPublishers() - Method in class nl.siegmann.epublib.domain.Metadata

getReader() - Method in class nl.siegmann.epublib.domain.Resource

Gets the contents of the Resource as Reader.

getReferences() - Method in class nl.siegmann.epublib.domain.Guide

getRelator() - Method in class nl.siegmann.epublib.domain.Author

getResource() - Method in class nl.siegmann.epublib.domain.ResourceReference

getResource(int) - Method in class nl.siegmann.epublib.domain.Spine

Gets the resource at the given index.

getResourceId() - Method in class nl.siegmann.epublib.domain.ResourceReference

The id of the reference referred to.

getResourceIndex(Resource) - Method in class nl.siegmann.epublib.domain.Spine

The position within the spine of the given resource.

getResourceIndex(String) - Method in class nl.siegmann.epublib.domain.Spine

The first position within the spine of a resource with the given href.

getResourceMap() - Method in class nl.siegmann.epublib.domain.Resources

The resources that make up this book.

getResources() - Method in class nl.siegmann.epublib.domain.Book

The collection of all images, chapters, sections, xhtml files, stylesheets, etc that make up the book.

getResourcesByMediaType(MediaType) - Method in class nl.siegmann.epublib.domain.Resources

All resources that have the given MediaType.

getResourcesByMediaTypes(MediaType[]) - Method in class nl.siegmann.epublib.domain.Resources

All Resources that match any of the given list of MediaTypes

getRights() - Method in class nl.siegmann.epublib.domain.Metadata

getScheme() - Method in class nl.siegmann.epublib.domain.Identifier

getSpine() - Method in class nl.siegmann.epublib.domain.Book

The sections of the book that should be shown if a user reads the book from start to finish.

getSpineReferences() - Method in class nl.siegmann.epublib.domain.Spine

getSubjects() - Method in class nl.siegmann.epublib.domain.Metadata

getTableOfContents() - Method in class nl.siegmann.epublib.domain.Book

The Table of Contents of the book.

getTitle() - Method in class nl.siegmann.epublib.domain.Book

Gets the first non-blank title from the book's metadata.

getTitle() - Method in class nl.siegmann.epublib.domain.Resource

getTitle() - Method in class nl.siegmann.epublib.domain.TitledResourceReference

getTitles() - Method in class nl.siegmann.epublib.domain.Metadata

getTocReferences() - Method in class nl.siegmann.epublib.domain.TableOfContents

getTocResource() - Method in class nl.siegmann.epublib.domain.Spine

The resource containing the XML for the tableOfContents.

getType() - Method in class nl.siegmann.epublib.domain.GuideReference

getTypes() - Method in class nl.siegmann.epublib.domain.Metadata

getValue() - Method in class nl.siegmann.epublib.domain.Date

getValue() - Method in class nl.siegmann.epublib.domain.Identifier

getXmlEncoding() - Method in exception nl.siegmann.epublib.util.commons.io.XmlStreamReaderException

Returns the encoding found in the XML prolog of the InputStream.

getXmlGuessEncoding() - Method in exception nl.siegmann.epublib.util.commons.io.XmlStreamReaderException

Returns the encoding guess based on the first bytes of the InputStream.

getXPathFactory() - Static method in class nl.siegmann.epublib.epub.EpubProcessorSupport

GIF - Static variable in class nl.siegmann.epublib.service.MediatypeService

GLOSSARY - Static variable in class nl.siegmann.epublib.domain.GuideReference

gotoBook(Book, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoFirstSpineSection(Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoLastSpineSection(Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoNextSpineSection(Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoPreviousSpineSection(Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoPreviousSpineSection(int, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoResource(String, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoResource(Resource, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoResource(Resource, String, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoResource(Resource, int, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoResource(Resource, int, String, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoResourceId(String, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoSpineSection(int, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

gotoSpineSection(int, int, Object) - Method in class nl.siegmann.epublib.browsersupport.Navigator

Go to a specific section.

Guide - Class in nl.siegmann.epublib.domain

The guide is a selection of special pages of the book.

Guide() - Constructor for class nl.siegmann.epublib.domain.Guide

guide - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFTags

GuideReference - Class in nl.siegmann.epublib.domain

These are references to elements of the book's guide.

GuideReference(Resource) - Constructor for class nl.siegmann.epublib.domain.GuideReference

GuideReference(Resource, String) - Constructor for class nl.siegmann.epublib.domain.GuideReference

GuideReference(Resource, String, String) - Constructor for class nl.siegmann.epublib.domain.GuideReference

GuideReference(Resource, String, String, String) - Constructor for class nl.siegmann.epublib.domain.GuideReference

H

handleIOException(IOException) - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Handle any IOExceptions thrown.

hasBOM() - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Indicates whether the stream contains one of the specified BOMs.

hasBOM(ByteOrderMark) - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Indicates whether the stream contains the specified BOM.

hashCode() - Method in class nl.siegmann.epublib.domain.Author

hashCode() - Method in class nl.siegmann.epublib.domain.Identifier

hashCode() - Method in class nl.siegmann.epublib.domain.MediaType

hashCode() - Method in class nl.siegmann.epublib.domain.Resource

hashCode() - Method in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

Return the hashcode for this BOM.

hashCode(String...) - Static method in class nl.siegmann.epublib.util.StringUtil

hasNextSpineSection() - Method in class nl.siegmann.epublib.browsersupport.Navigator

hasPreviousSpineSection() - Method in class nl.siegmann.epublib.browsersupport.Navigator

href - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

HtmlProcessor - Interface in nl.siegmann.epublib.epub

I

id - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCAttributes

id - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

Identifier - Class in nl.siegmann.epublib.domain

A Book's identifier.

Identifier() - Constructor for class nl.siegmann.epublib.domain.Identifier

Creates an Identifier with as value a random UUID and scheme "UUID"

Identifier(String, String) - Constructor for class nl.siegmann.epublib.domain.Identifier

identifier - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

Identifier.Scheme - Interface in nl.siegmann.epublib.domain

IDENTITY_BOOKPROCESSOR - Static variable in interface nl.siegmann.epublib.epub.BookProcessor

A BookProcessor that returns the input book unchanged.

idref - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

INDEX - Static variable in class nl.siegmann.epublib.domain.GuideReference

back-of-book style index

initBook(Book) - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

IO_COPY_BUFFER_SIZE - Static variable in class nl.siegmann.epublib.util.IOUtil

IOUtil - Class in nl.siegmann.epublib.util

Most of the functions herein are re-implementations of the ones in apache io IOUtils.

IOUtil() - Constructor for class nl.siegmann.epublib.util.IOUtil

isAutoGeneratedId() - Method in class nl.siegmann.epublib.domain.Metadata

isBitmapImage(MediaType) - Static method in class nl.siegmann.epublib.service.MediatypeService

isBlank(String) - Static method in class nl.siegmann.epublib.util.StringUtil

Whether the String is null, zero-length and does contain only whitespace.

ISBN - Static variable in interface nl.siegmann.epublib.domain.Identifier.Scheme

isBookChanged() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

isBookId() - Method in class nl.siegmann.epublib.domain.Identifier

This bookId property allows the book creator to add multiple ids and tell the epubwriter which one to write out as the bookId.

isEmpty() - Method in class nl.siegmann.epublib.domain.Resources

isEmpty() - Method in class nl.siegmann.epublib.domain.Spine

isEmpty(String) - Static method in class nl.siegmann.epublib.util.StringUtil

Whether the given string is null or zero-length.

isFragmentChanged() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

isLinear() - Method in class nl.siegmann.epublib.domain.SpineReference

Linear denotes whether the section is Primary or Auxiliary.

isNotBlank(String) - Static method in class nl.siegmann.epublib.util.StringUtil

Whether the String is not null, not zero-length and does not contain of only whitespace.

isResourceChanged() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

isSectionPosChanged() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

isSpinePosChanged() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

item - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFTags

itemref - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFTags

J

JPG - Static variable in class nl.siegmann.epublib.service.MediatypeService

L

language - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

length() - Method in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

Return the length of the BOM's bytes.

linear - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

LOI - Static variable in class nl.siegmann.epublib.domain.GuideReference

list of illustrations

LOT - Static variable in class nl.siegmann.epublib.domain.GuideReference

list of tables

M

Main - Class in nl.siegmann.epublib.epub

Main() - Constructor for class nl.siegmann.epublib.epub.Main

manifest - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFTags

mark(int) - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Invokes the delegate's mark(int) method.

mark(int) - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invokes the delegate's mark(int) method.

markSupported() - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invokes the delegate's markSupported() method.

media_type - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

MediaType - Class in nl.siegmann.epublib.domain

MediaType is used to tell the type of content a resource is.

MediaType(String, String) - Constructor for class nl.siegmann.epublib.domain.MediaType

MediaType(String, String, String[]) - Constructor for class nl.siegmann.epublib.domain.MediaType

MediaType(String, String, Collection<String>) - Constructor for class nl.siegmann.epublib.domain.MediaType

mediatypes - Static variable in class nl.siegmann.epublib.service.MediatypeService

mediaTypesByName - Static variable in class nl.siegmann.epublib.service.MediatypeService

MediatypeService - Class in nl.siegmann.epublib.service

Manages mediatypes that are used by epubs

MediatypeService() - Constructor for class nl.siegmann.epublib.service.MediatypeService

meta - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFTags

meta_cover - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFValues

Metadata - Class in nl.siegmann.epublib.domain

A Book's collection of Metadata.

Metadata() - Constructor for class nl.siegmann.epublib.domain.Metadata

metadata - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFTags

move(int) - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

Moves the current positions delta positions.

N

name - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

NAMESPACE_DUBLIN_CORE - Static variable in class nl.siegmann.epublib.epub.PackageDocumentBase

NAMESPACE_NCX - Static variable in class nl.siegmann.epublib.epub.NCXDocument

NAMESPACE_OPF - Static variable in class nl.siegmann.epublib.epub.PackageDocumentBase

NAMESPACE_XHTML - Static variable in interface nl.siegmann.epublib.Constants

NavigationEvent - Class in nl.siegmann.epublib.browsersupport

Used to tell NavigationEventListener just what kind of navigation action the user just did.

NavigationEvent(Object) - Constructor for class nl.siegmann.epublib.browsersupport.NavigationEvent

NavigationEvent(Object, Navigator) - Constructor for class nl.siegmann.epublib.browsersupport.NavigationEvent

NavigationEventListener - Interface in nl.siegmann.epublib.browsersupport

Implemented by classes that want to be notified if the user moves to another location in the book.

NavigationHistory - Class in nl.siegmann.epublib.browsersupport

A history of the user's locations with the epub.

NavigationHistory(Navigator) - Constructor for class nl.siegmann.epublib.browsersupport.NavigationHistory

navigationPerformed(NavigationEvent) - Method in interface nl.siegmann.epublib.browsersupport.NavigationEventListener

Called whenever the user navigates to another position in the book.

navigationPerformed(NavigationEvent) - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

If this is not the source of the navigationEvent then the addLocation will be called with the href of the currentResource in the navigationEvent.

Navigator - Class in nl.siegmann.epublib.browsersupport

A helper class for epub browser applications.

Navigator() - Constructor for class nl.siegmann.epublib.browsersupport.Navigator

Navigator(Book) - Constructor for class nl.siegmann.epublib.browsersupport.Navigator

NCX - Static variable in class nl.siegmann.epublib.service.MediatypeService

NCX_ITEM_ID - Static variable in class nl.siegmann.epublib.epub.NCXDocument

NCXDocument - Class in nl.siegmann.epublib.epub

Writes the ncx document as defined by namespace http://www.daisy.org/z3986/2005/ncx/

NCXDocument() - Constructor for class nl.siegmann.epublib.epub.NCXDocument

nl.siegmann.epublib - package nl.siegmann.epublib

nl.siegmann.epublib.browsersupport - package nl.siegmann.epublib.browsersupport

Provides classes that help make an epub reader application.

nl.siegmann.epublib.domain - package nl.siegmann.epublib.domain

nl.siegmann.epublib.epub - package nl.siegmann.epublib.epub

nl.siegmann.epublib.service - package nl.siegmann.epublib.service

nl.siegmann.epublib.util - package nl.siegmann.epublib.util

nl.siegmann.epublib.util.commons.io - package nl.siegmann.epublib.util.commons.io

nl.siegmann.epublib.utilities - package nl.siegmann.epublib.utilities

no - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFValues

NoCloseOutputStream - Class in nl.siegmann.epublib.util

OutputStream with the close() disabled.

NoCloseOutputStream(OutputStream) - Constructor for class nl.siegmann.epublib.util.NoCloseOutputStream

NoCloseWriter - Class in nl.siegmann.epublib.util

Writer with the close() disabled.

NoCloseWriter(Writer) - Constructor for class nl.siegmann.epublib.util.NoCloseWriter

NOTES - Static variable in class nl.siegmann.epublib.domain.GuideReference

O

OPENTYPE - Static variable in class nl.siegmann.epublib.service.MediatypeService

out - Variable in class nl.siegmann.epublib.utilities.StreamWriterDelegate

P

PackageDocumentBase - Class in nl.siegmann.epublib.epub

Functionality shared by the PackageDocumentReader and the PackageDocumentWriter

PackageDocumentBase() - Constructor for class nl.siegmann.epublib.epub.PackageDocumentBase

PackageDocumentBase.DCAttributes - Interface in nl.siegmann.epublib.epub

PackageDocumentBase.DCTags - Interface in nl.siegmann.epublib.epub

PackageDocumentBase.OPFAttributes - Interface in nl.siegmann.epublib.epub

PackageDocumentBase.OPFTags - Interface in nl.siegmann.epublib.epub

PackageDocumentBase.OPFValues - Interface in nl.siegmann.epublib.epub

PackageDocumentMetadataWriter - Class in nl.siegmann.epublib.epub

PackageDocumentMetadataWriter() - Constructor for class nl.siegmann.epublib.epub.PackageDocumentMetadataWriter

PackageDocumentReader - Class in nl.siegmann.epublib.epub

Reads the opf package document as defined by namespace http://www.idpf.org/2007/opf

PackageDocumentReader() - Constructor for class nl.siegmann.epublib.epub.PackageDocumentReader

PackageDocumentWriter - Class in nl.siegmann.epublib.epub

Writes the opf package document as defined by namespace http://www.idpf.org/2007/opf

PackageDocumentWriter() - Constructor for class nl.siegmann.epublib.epub.PackageDocumentWriter

packageTag - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFTags

PNG - Static variable in class nl.siegmann.epublib.service.MediatypeService

PREFACE - Static variable in class nl.siegmann.epublib.domain.GuideReference

PREFIX_DTB - Static variable in class nl.siegmann.epublib.epub.NCXDocument

PREFIX_DUBLIN_CORE - Static variable in class nl.siegmann.epublib.epub.PackageDocumentBase

PREFIX_NCX - Static variable in class nl.siegmann.epublib.epub.NCXDocument

PREFIX_OPF - Static variable in class nl.siegmann.epublib.epub.PackageDocumentBase

processBook(Book) - Method in interface nl.siegmann.epublib.epub.BookProcessor

processBook(Book) - Method in class nl.siegmann.epublib.epub.BookProcessorPipeline

processHtmlResource(Resource, OutputStream) - Method in interface nl.siegmann.epublib.epub.HtmlProcessor

ProxyInputStream - Class in nl.siegmann.epublib.util.commons.io

A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called.

ProxyInputStream(InputStream) - Constructor for class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Constructs a new ProxyInputStream.

publisher - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

R

read(Book, EpubReader) - Static method in class nl.siegmann.epublib.epub.NCXDocument

read(Resource, EpubReader, Book, Map<String, Resource>) - Static method in class nl.siegmann.epublib.epub.PackageDocumentReader

read() - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Invokes the delegate's read() method, detecting and optionally skipping BOM.

read(byte[], int, int) - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Invokes the delegate's read(byte[], int, int) method, detecting and optionally skipping BOM.

read(byte[]) - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Invokes the delegate's read(byte[]) method, detecting and optionally skipping BOM.

read() - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invokes the delegate's read() method.

read(byte[]) - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invokes the delegate's read(byte[]) method.

read(byte[], int, int) - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invokes the delegate's read(byte[], int, int) method.

read(char[], int, int) - Method in class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Invokes the underlying reader's read(char[], int, int) method.

readEpub(InputStream) - Method in class nl.siegmann.epublib.epub.EpubReader

readEpub(ZipInputStream) - Method in class nl.siegmann.epublib.epub.EpubReader

readEpub(InputStream, String) - Method in class nl.siegmann.epublib.epub.EpubReader

Read epub from inputstream

readEpub(ZipInputStream, String) - Method in class nl.siegmann.epublib.epub.EpubReader

reference - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFTags

reference_cover - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFValues

relation - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

Relator - Enum in nl.siegmann.epublib.domain

A relator denotes which role a certain individual had in the creation/modification of the ebook.

remove(String) - Method in class nl.siegmann.epublib.domain.Resources

Remove the resource with the given href.

removeNavigationEventListener(NavigationEventListener) - Method in class nl.siegmann.epublib.browsersupport.Navigator

reset() - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Invokes the delegate's reset() method.

reset() - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invokes the delegate's reset() method.

Resource - Class in nl.siegmann.epublib.domain

Represents a resource that is part of the epub.

Resource(String) - Constructor for class nl.siegmann.epublib.domain.Resource

Resource(byte[], MediaType) - Constructor for class nl.siegmann.epublib.domain.Resource

Resource(byte[], String) - Constructor for class nl.siegmann.epublib.domain.Resource

Resource(InputStream, String) - Constructor for class nl.siegmann.epublib.domain.Resource

Resource(Reader, String) - Constructor for class nl.siegmann.epublib.domain.Resource

Resource(String, byte[], String, MediaType) - Constructor for class nl.siegmann.epublib.domain.Resource

Resource(String, byte[], String, MediaType, String) - Constructor for class nl.siegmann.epublib.domain.Resource

resource - Variable in class nl.siegmann.epublib.domain.ResourceReference

ResourceReference - Class in nl.siegmann.epublib.domain

ResourceReference(Resource) - Constructor for class nl.siegmann.epublib.domain.ResourceReference

Resources - Class in nl.siegmann.epublib.domain

All the resources that make up the book.

Resources() - Constructor for class nl.siegmann.epublib.domain.Resources

ResourceUtil - Class in nl.siegmann.epublib.util

Various resource utility methods

ResourceUtil() - Constructor for class nl.siegmann.epublib.util.ResourceUtil

rights - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

role - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

S

scheme - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCAttributes

scheme - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

set(Collection<Resource>) - Method in class nl.siegmann.epublib.domain.Resources

Sets the collection of Resources to the given collection of resources

set(Map<String, Resource>) - Method in class nl.siegmann.epublib.domain.Resources

Sets the collection of Resources to the given collection of resources

setAuthors(List<Author>) - Method in class nl.siegmann.epublib.domain.Metadata

setBookId(boolean) - Method in class nl.siegmann.epublib.domain.Identifier

setBookProcessingPipeline(List<BookProcessor>) - Method in class nl.siegmann.epublib.epub.BookProcessorPipeline

setChildren(List<TOCReference>) - Method in class nl.siegmann.epublib.domain.TOCReference

setContributors(List<Author>) - Method in class nl.siegmann.epublib.domain.Metadata

setCoverImage(Resource) - Method in class nl.siegmann.epublib.domain.Book

setCoverImage(Resource) - Method in class nl.siegmann.epublib.domain.Metadata

setCoverPage(Resource) - Method in class nl.siegmann.epublib.domain.Book

setCoverPage(Resource) - Method in class nl.siegmann.epublib.domain.Guide

setCoverReference(GuideReference) - Method in class nl.siegmann.epublib.domain.Guide

setCurrentResource(Resource) - Method in class nl.siegmann.epublib.browsersupport.Navigator

Sets the current index and resource without calling the eventlisteners.

setCurrentSpinePos(int) - Method in class nl.siegmann.epublib.browsersupport.Navigator

Sets the current index and resource without calling the eventlisteners.

setData(byte[]) - Method in class nl.siegmann.epublib.domain.Resource

setDates(List<Date>) - Method in class nl.siegmann.epublib.domain.Metadata

setDefaultNamespace(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

setDescriptions(List<String>) - Method in class nl.siegmann.epublib.domain.Metadata

setEvent(Date.Event) - Method in class nl.siegmann.epublib.domain.Date

setFirstname(String) - Method in class nl.siegmann.epublib.domain.Author

setFormat(String) - Method in class nl.siegmann.epublib.domain.Metadata

setFragmentId(String) - Method in class nl.siegmann.epublib.domain.TitledResourceReference

setHistoryWaitTime(long) - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

setHref(String) - Method in class nl.siegmann.epublib.domain.Resource

setHtmlProcessor(HtmlProcessor) - Method in class nl.siegmann.epublib.epub.EpubWriter

setId(String) - Method in class nl.siegmann.epublib.domain.Resource

setIdentifiers(List<Identifier>) - Method in class nl.siegmann.epublib.domain.Metadata

setInputEncoding(String) - Method in class nl.siegmann.epublib.domain.Resource

setLanguage(String) - Method in class nl.siegmann.epublib.domain.Metadata

setLastname(String) - Method in class nl.siegmann.epublib.domain.Author

setLinear(boolean) - Method in class nl.siegmann.epublib.domain.SpineReference

setMaxHistorySize(int) - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory

setMediaType(MediaType) - Method in class nl.siegmann.epublib.domain.Resource

setMetadata(Metadata) - Method in class nl.siegmann.epublib.domain.Book

setNamespaceContext(NamespaceContext) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

setNavigator(Navigator) - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

setNcxResource(Resource) - Method in class nl.siegmann.epublib.domain.Book

setOldBook(Book) - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

setOldResource(Resource) - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

setOldSpinePos(int) - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

setOpfResource(Resource) - Method in class nl.siegmann.epublib.domain.Book

setOtherProperties(Map<QName, String>) - Method in class nl.siegmann.epublib.domain.Metadata

setPrefix(String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

setPublishers(List<String>) - Method in class nl.siegmann.epublib.domain.Metadata

setReferences(List<GuideReference>) - Method in class nl.siegmann.epublib.domain.Guide

setRelator(Relator) - Method in class nl.siegmann.epublib.domain.Author

setResource(Resource) - Method in class nl.siegmann.epublib.domain.ResourceReference

Besides setting the resource it also sets the fragmentId to null.

setResource(Resource, String) - Method in class nl.siegmann.epublib.domain.TitledResourceReference

setResource(Resource) - Method in class nl.siegmann.epublib.domain.TitledResourceReference

Sets the resource to the given resource and sets the fragmentId to null.

setResources(Resources) - Method in class nl.siegmann.epublib.domain.Book

setRights(List<String>) - Method in class nl.siegmann.epublib.domain.Metadata

setRole(String) - Method in class nl.siegmann.epublib.domain.Author

setScheme(String) - Method in class nl.siegmann.epublib.domain.Identifier

setSpine(Spine) - Method in class nl.siegmann.epublib.domain.Book

setSpineReferences(List<SpineReference>) - Method in class nl.siegmann.epublib.domain.Spine

setSubjects(List<String>) - Method in class nl.siegmann.epublib.domain.Metadata

setTableOfContents(TableOfContents) - Method in class nl.siegmann.epublib.domain.Book

setTitle(String) - Method in class nl.siegmann.epublib.domain.Resource

setTitle(String) - Method in class nl.siegmann.epublib.domain.TitledResourceReference

setTitles(List<String>) - Method in class nl.siegmann.epublib.domain.Metadata

setTocReferences(List<TOCReference>) - Method in class nl.siegmann.epublib.domain.TableOfContents

setTocResource(Resource) - Method in class nl.siegmann.epublib.domain.Spine

As per the epub file format the spine officially maintains a reference to the Table of Contents.

setType(String) - Method in class nl.siegmann.epublib.domain.GuideReference

setTypes(List<String>) - Method in class nl.siegmann.epublib.domain.Metadata

setValue(String) - Method in class nl.siegmann.epublib.domain.Identifier

size() - Method in class nl.siegmann.epublib.domain.Resources

The number of resources

size() - Method in class nl.siegmann.epublib.domain.Spine

The number of elements in the spine.

size() - Method in class nl.siegmann.epublib.domain.TableOfContents

The total number of references in this table of contents.

skip(long) - Method in class nl.siegmann.epublib.util.commons.io.BOMInputStream

Invokes the delegate's skip(long) method, detecting and optionallyskipping BOM.

skip(long) - Method in class nl.siegmann.epublib.util.commons.io.ProxyInputStream

Invokes the delegate's skip(long) method.

source - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

Spine - Class in nl.siegmann.epublib.domain

The spine sections are the sections of the book in the order in which the book should be read.

Spine() - Constructor for class nl.siegmann.epublib.domain.Spine

Spine(TableOfContents) - Constructor for class nl.siegmann.epublib.domain.Spine

Creates a spine out of all the resources in the table of contents.

Spine(List<SpineReference>) - Constructor for class nl.siegmann.epublib.domain.Spine

spine - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFTags

SpineReference - Class in nl.siegmann.epublib.domain

A Section of a book.

SpineReference(Resource) - Constructor for class nl.siegmann.epublib.domain.SpineReference

SpineReference(Resource, boolean) - Constructor for class nl.siegmann.epublib.domain.SpineReference

StreamWriterDelegate - Class in nl.siegmann.epublib.utilities

Abstract class for writing filtered XML streams.

StreamWriterDelegate(XMLStreamWriter) - Constructor for class nl.siegmann.epublib.utilities.StreamWriterDelegate

StringUtil - Class in nl.siegmann.epublib.util

Various String utility functions.

StringUtil() - Constructor for class nl.siegmann.epublib.util.StringUtil

subject - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

substringAfter(String, char) - Static method in class nl.siegmann.epublib.util.StringUtil

Gives the substring of the given text after the given separator.

substringAfterLast(String, char) - Static method in class nl.siegmann.epublib.util.StringUtil

Gives the substring of the given text after the last occurrence of the given separator.

substringBefore(String, char) - Static method in class nl.siegmann.epublib.util.StringUtil

Gives the substring of the given text before the given separator.

substringBeforeLast(String, char) - Static method in class nl.siegmann.epublib.util.StringUtil

Gives the substring of the given text before the last occurrence of the given separator.

SVG - Static variable in class nl.siegmann.epublib.service.MediatypeService

T

TableOfContents - Class in nl.siegmann.epublib.domain

The table of contents of the book.

TableOfContents() - Constructor for class nl.siegmann.epublib.domain.TableOfContents

TableOfContents(List<TOCReference>) - Constructor for class nl.siegmann.epublib.domain.TableOfContents

TEXT - Static variable in class nl.siegmann.epublib.domain.GuideReference

A page of content (e.g.

title - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

title - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

TITLE_PAGE - Static variable in class nl.siegmann.epublib.domain.GuideReference

human-readable page with title, author, publisher, and other metadata

TitledResourceReference - Class in nl.siegmann.epublib.domain

TitledResourceReference(Resource) - Constructor for class nl.siegmann.epublib.domain.TitledResourceReference

TitledResourceReference(Resource, String) - Constructor for class nl.siegmann.epublib.domain.TitledResourceReference

TitledResourceReference(Resource, String, String) - Constructor for class nl.siegmann.epublib.domain.TitledResourceReference

toByteArray(Reader, String) - Static method in class nl.siegmann.epublib.util.IOUtil

Gets the contents of the Reader as a byte[], with the given character encoding.

toByteArray(InputStream) - Static method in class nl.siegmann.epublib.util.IOUtil

Returns the contents of the InputStream as a byte[]

TOC - Static variable in class nl.siegmann.epublib.domain.GuideReference

Human-readable table of contents.

toc - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

TOCReference - Class in nl.siegmann.epublib.domain

An item in the Table of Contents.

TOCReference() - Constructor for class nl.siegmann.epublib.domain.TOCReference

TOCReference(String, Resource) - Constructor for class nl.siegmann.epublib.domain.TOCReference

TOCReference(String, Resource, String) - Constructor for class nl.siegmann.epublib.domain.TOCReference

TOCReference(String, Resource, String, List<TOCReference>) - Constructor for class nl.siegmann.epublib.domain.TOCReference

toString() - Method in class nl.siegmann.epublib.browsersupport.NavigationEvent

toString() - Method in class nl.siegmann.epublib.domain.Author

toString() - Method in enum nl.siegmann.epublib.domain.Date.Event

toString() - Method in class nl.siegmann.epublib.domain.Date

toString() - Method in class nl.siegmann.epublib.domain.Identifier

toString() - Method in class nl.siegmann.epublib.domain.MediaType

toString() - Method in class nl.siegmann.epublib.domain.Resource

toString() - Method in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

Provide a String representation of the BOM.

toString(Object...) - Static method in class nl.siegmann.epublib.util.StringUtil

Pretty toString printer.

TTF - Static variable in class nl.siegmann.epublib.service.MediatypeService

type - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags

type - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

U

uniqueIdentifier - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

URI - Static variable in interface nl.siegmann.epublib.domain.Identifier.Scheme

URL - Static variable in interface nl.siegmann.epublib.domain.Identifier.Scheme

UTF_16BE - Static variable in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

UTF-16BE BOM (Big Endian)

UTF_16LE - Static variable in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

UTF-16LE BOM (Little Endian)

UTF_8 - Static variable in class nl.siegmann.epublib.util.commons.io.ByteOrderMark

UTF-8 BOM

UUID - Static variable in interface nl.siegmann.epublib.domain.Identifier.Scheme

V

valueOf(String) - Static method in enum nl.siegmann.epublib.domain.Date.Event

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum nl.siegmann.epublib.domain.Relator

Returns the enum constant of this type with the specified name.

values() - Static method in enum nl.siegmann.epublib.domain.Date.Event

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum nl.siegmann.epublib.domain.Relator

Returns an array containing the constants of this enum type, in the order they are declared.

version - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes

W

write(Book, OutputStream) - Method in class nl.siegmann.epublib.epub.EpubWriter

write(EpubWriter, Book, ZipOutputStream) - Static method in class nl.siegmann.epublib.epub.NCXDocument

write(XmlSerializer, Book) - Static method in class nl.siegmann.epublib.epub.NCXDocument

Generates a resource containing an xml document containing the table of contents of the book in ncx format.

write(XmlSerializer, List<Identifier>, String, List<Author>, TableOfContents) - Static method in class nl.siegmann.epublib.epub.NCXDocument

write(EpubWriter, XmlSerializer, Book) - Static method in class nl.siegmann.epublib.epub.PackageDocumentWriter

write(int) - Method in class nl.siegmann.epublib.util.NoCloseOutputStream

write(char[], int, int) - Method in class nl.siegmann.epublib.util.NoCloseWriter

writeAttribute(String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeAttribute(String, String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeAttribute(String, String, String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeCData(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeCharacters(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeCharacters(char[], int, int) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeComment(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeDefaultNamespace(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeDTD(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeEmptyElement(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeEmptyElement(String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeEmptyElement(String, String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeEndDocument() - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeEndElement() - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeEntityRef(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeMetaData(Book, XmlSerializer) - Static method in class nl.siegmann.epublib.epub.PackageDocumentMetadataWriter

Writes the book's metadata.

writeNamespace(String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeProcessingInstruction(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeProcessingInstruction(String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeStartDocument() - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeStartDocument(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeStartDocument(String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeStartElement(String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeStartElement(String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

writeStartElement(String, String, String) - Method in class nl.siegmann.epublib.utilities.StreamWriterDelegate

X

XHTML - Static variable in class nl.siegmann.epublib.service.MediatypeService

XmlStreamReader - Class in nl.siegmann.epublib.util.commons.io

Character stream that handles all the necessary Voodo to figure out the charset encoding of the XML document within the stream.

XmlStreamReader(File) - Constructor for class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Creates a Reader for a File.

XmlStreamReader(InputStream) - Constructor for class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Creates a Reader for a raw InputStream.

XmlStreamReader(InputStream, boolean) - Constructor for class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Creates a Reader for a raw InputStream.

XmlStreamReader(InputStream, boolean, String) - Constructor for class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Creates a Reader for a raw InputStream.

XmlStreamReader(URL) - Constructor for class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Creates a Reader using the InputStream of a URL.

XmlStreamReader(URLConnection, String) - Constructor for class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Creates a Reader using the InputStream of a URLConnection.

XmlStreamReader(InputStream, String) - Constructor for class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Creates a Reader using an InputStream an the associated content-type header.

XmlStreamReader(InputStream, String, boolean, String) - Constructor for class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Creates a Reader using an InputStream an the associated content-type header.

XmlStreamReader(InputStream, String, boolean) - Constructor for class nl.siegmann.epublib.util.commons.io.XmlStreamReader

Creates a Reader using an InputStream an the associated content-type header.

XmlStreamReaderException - Exception in nl.siegmann.epublib.util.commons.io

The XmlStreamReaderException is thrown by the XmlStreamReader constructors if the charset encoding can not be determined according to the XML 1.0 specification and RFC 3023.

XmlStreamReaderException(String, String, String, String) - Constructor for exception nl.siegmann.epublib.util.commons.io.XmlStreamReaderException

Creates an exception instance if the charset encoding could not be determined.

XmlStreamReaderException(String, String, String, String, String, String) - Constructor for exception nl.siegmann.epublib.util.commons.io.XmlStreamReaderException

Creates an exception instance if the charset encoding could not be determined.

xPathFactory - Static variable in class nl.siegmann.epublib.epub.EpubProcessorSupport

XPGT - Static variable in class nl.siegmann.epublib.service.MediatypeService

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