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

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
 
addBookProcessors(Collection<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.
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.
addSection(Resource, String) - Method in class nl.siegmann.epublib.domain.TableOfContents
Calls addTOCReferenceAtLocation after splitting the path using the DEFAULT_PATH_SEPARATOR.
addSection(Resource, String, String) - Method in class nl.siegmann.epublib.domain.TableOfContents
Calls addTOCReferenceAtLocation after splitting the path using the given pathSeparator.
addSection(Resource, String[]) - Method in class nl.siegmann.epublib.domain.TableOfContents
Adds the given Resources to the TableOfContents at the location specified by the pathElements.
addSection(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.
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(TOCReference) - Method in class nl.siegmann.epublib.domain.TableOfContents
 
addType(String) - Method in class nl.siegmann.epublib.domain.Metadata
 
Adler32 - Class in net.sf.jazzlib
Computes Adler32 checksum for a stream of data.
Adler32() - Constructor for class net.sf.jazzlib.Adler32
Creates a new instance of the Adler32 class.
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 net.sf.jazzlib.InflaterInputStream
Returns 0 once the end of the stream (EOF) has been reached.
available() - Method in class net.sf.jazzlib.ZipInputStream
 
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.
BEST_COMPRESSION - Static variable in class net.sf.jazzlib.Deflater
The best and slowest compression level.
BEST_SPEED - Static variable in class net.sf.jazzlib.Deflater
The worst but fastest compression level.
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
 
buf - Variable in class net.sf.jazzlib.DeflaterOutputStream
This buffer is used temporarily to retrieve the bytes from the deflater and write them to the underlying output stream.
buf - Variable in class net.sf.jazzlib.InflaterInputStream
Byte array used as a buffer
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
The maximum depth of the reference tree
CHARACTER_ENCODING - Static variable in interface nl.siegmann.epublib.Constants
 
CheckedInputStream - Class in net.sf.jazzlib
InputStream that computes a checksum of the data being read using a supplied Checksum object.
CheckedInputStream(InputStream, Checksum) - Constructor for class net.sf.jazzlib.CheckedInputStream
Creates a new CheckInputStream on top of the supplied OutputStream using the supplied Checksum.
CheckedOutputStream - Class in net.sf.jazzlib
OutputStream that computes a checksum of data being written using a supplied Checksum object.
CheckedOutputStream(OutputStream, Checksum) - Constructor for class net.sf.jazzlib.CheckedOutputStream
Creates a new CheckInputStream on top of the supplied OutputStream using the supplied Checksum.
Checksum - Interface in net.sf.jazzlib
Interface to compute a data checksum used by checked input/output streams.
clone() - Method in class net.sf.jazzlib.ZipEntry
Clones the entry.
close() - Method in class net.sf.jazzlib.DeflaterOutputStream
Calls finish () and closes the stream.
close() - Method in class net.sf.jazzlib.GZIPInputStream
Closes the input stream.
close() - Method in class net.sf.jazzlib.GZIPOutputStream
Writes remaining compressed output data to the output stream and closes it.
close() - Method in class net.sf.jazzlib.InflaterInputStream
Closes the input stream
close() - Method in class net.sf.jazzlib.ZipFile
Closes the ZipFile.
close() - Method in class net.sf.jazzlib.ZipInputStream
Closes the zip file.
close() - Method in class nl.siegmann.epublib.domain.LazyResource
Tells this resource to release its cached data.
close() - Method in class nl.siegmann.epublib.domain.Resource
Tells this resource to release its cached data.
close() - Method in class nl.siegmann.epublib.domain.ResourceInputStream
 
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
 
closeEntry() - Method in class net.sf.jazzlib.ZipInputStream
Closes the current zip entry and moves to the next one.
closeEntry() - Method in class net.sf.jazzlib.ZipOutputStream
Closes the current entry.
collapsePathDots(String) - Static method in class nl.siegmann.epublib.util.StringUtil
Changes a path containing '..', '.' and empty dirs into a path that doesn't.
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
Whether the map of resources already contains a resource with the given id.
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
 
crc - Variable in class net.sf.jazzlib.GZIPInputStream
The CRC-32 checksum value for uncompressed data.
crc - Variable in class net.sf.jazzlib.GZIPOutputStream
CRC-32 value for uncompressed data
CRC32 - Class in net.sf.jazzlib
Computes CRC32 data checksum of a data stream.
CRC32() - Constructor for class net.sf.jazzlib.CRC32
 
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.
createEnumerationFromIterator(Iterator<T>) - Static method in class nl.siegmann.epublib.util.CollectionUtil
Creates an Enumeration out of the given Iterator.
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.
createResource(ZipEntry, InputStream) - Static method in class nl.siegmann.epublib.util.ResourceUtil
 
createSpineReferences(Collection<Resource>) - Static method in class nl.siegmann.epublib.domain.Spine
 
createXmlSerializer(OutputStream) - Static method in class nl.siegmann.epublib.epub.EpubProcessorSupport
 
createXmlSerializer(Writer) - Static method in class nl.siegmann.epublib.epub.EpubProcessorSupport
 
createZipEntry(String) - Method in class net.sf.jazzlib.ZipInputStream
Creates a new zip entry for the given name.
creator - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags
 
CSS - Static variable in class nl.siegmann.epublib.service.MediatypeService
 

D

data - Variable in class nl.siegmann.epublib.domain.Resource
 
DataFormatException - Exception in net.sf.jazzlib
Exception thrown when compressed data is corrupt.
DataFormatException() - Constructor for exception net.sf.jazzlib.DataFormatException
Create an exception without a message.
DataFormatException(String) - Constructor for exception net.sf.jazzlib.DataFormatException
Create an exception with a message.
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
 
def - Variable in class net.sf.jazzlib.DeflaterOutputStream
The deflater which is used to deflate the stream.
DEFAULT_COMPRESSION - Static variable in class net.sf.jazzlib.Deflater
The default compression level.
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_STRATEGY - Static variable in class net.sf.jazzlib.Deflater
The default strategy.
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.
defDistTree - Static variable in class net.sf.jazzlib.InflaterHuffmanTree
 
deflate(byte[]) - Method in class net.sf.jazzlib.Deflater
Deflates the current input block to the given array.
deflate(byte[], int, int) - Method in class net.sf.jazzlib.Deflater
Deflates the current input block to the given array.
deflate() - Method in class net.sf.jazzlib.DeflaterOutputStream
Deflates everything in the def's input buffers.
DEFLATED - Static variable in class net.sf.jazzlib.Deflater
The compression method.
DEFLATED - Static variable in class net.sf.jazzlib.ZipEntry
Compression method.
DEFLATED - Static variable in class net.sf.jazzlib.ZipOutputStream
Compression method.
Deflater - Class in net.sf.jazzlib
This is the Deflater class.
Deflater() - Constructor for class net.sf.jazzlib.Deflater
Creates a new deflater with default compression level.
Deflater(int) - Constructor for class net.sf.jazzlib.Deflater
Creates a new deflater with given compression level.
Deflater(int, boolean) - Constructor for class net.sf.jazzlib.Deflater
Creates a new deflater with given compression level.
DeflaterOutputStream - Class in net.sf.jazzlib
This is a special FilterOutputStream deflating the bytes that are written through it.
DeflaterOutputStream(OutputStream) - Constructor for class net.sf.jazzlib.DeflaterOutputStream
Creates a new DeflaterOutputStream with a default Deflater and default buffer size.
DeflaterOutputStream(OutputStream, Deflater) - Constructor for class net.sf.jazzlib.DeflaterOutputStream
Creates a new DeflaterOutputStream with the given Deflater and default buffer size.
DeflaterOutputStream(OutputStream, Deflater, int) - Constructor for class net.sf.jazzlib.DeflaterOutputStream
Creates a new DeflaterOutputStream with the given Deflater and buffer size.
defLitLenTree - Static variable in class net.sf.jazzlib.InflaterHuffmanTree
 
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.
DOCTYPE_XHTML - Static variable in interface nl.siegmann.epublib.Constants
 
documentBuilderFactory - Static variable in class nl.siegmann.epublib.epub.EpubProcessorSupport
 

E

ENCODING_PATTERN - Static variable in class nl.siegmann.epublib.util.commons.io.XmlStreamReader
 
end() - Method in class net.sf.jazzlib.Deflater
Deprecated.
Just clear all references to deflater instead.
end() - Method in class net.sf.jazzlib.Inflater
Deprecated.
Just clear all references to inflater instead.
endsWithIgnoreCase(String, String) - Static method in class nl.siegmann.epublib.util.StringUtil
Whether the given source string ends with the given suffix, ignoring case.
entries() - Method in class net.sf.jazzlib.ZipFile
Returns an enumeration of all Zip entries in this Zip file.
eos - Variable in class net.sf.jazzlib.GZIPInputStream
Indicates whether or not the end of the stream has been reached.
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
Checks to see of the given resourceObject is a resource and whether its href is equal to this one.
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
 
fill() - Method in class net.sf.jazzlib.InflaterInputStream
Fills the buffer with more data to decompress.
FILTERED - Static variable in class net.sf.jazzlib.Deflater
This strategy will only allow longer string repetitions.
finalize() - Method in class net.sf.jazzlib.Deflater
Finalizes this object.
finalize() - Method in class net.sf.jazzlib.Inflater
Finalizes this object.
finalize() - Method in class net.sf.jazzlib.ZipFile
Calls the close() method when this ZipFile has not yet been explicitly closed.
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.
finish() - Method in class net.sf.jazzlib.Deflater
Finishes the deflater with the current input block.
finish() - Method in class net.sf.jazzlib.DeflaterOutputStream
Finishes the stream by calling finish() on the deflater.
finish() - Method in class net.sf.jazzlib.GZIPOutputStream
 
finish() - Method in class net.sf.jazzlib.ZipOutputStream
Finishes the stream.
finished() - Method in class net.sf.jazzlib.Deflater
Returns true iff the stream was finished and no more output bytes are available.
finished() - Method in class net.sf.jazzlib.Inflater
Returns true, if the inflater has finished.
first(List<T>) - Static method in class nl.siegmann.epublib.util.CollectionUtil
Returns the first element of the list, null if the list is null or empty.
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 net.sf.jazzlib.DeflaterOutputStream
Flushes the stream by calling flush() on the deflater and then on the underlying stream.
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.
getAdler() - Method in class net.sf.jazzlib.Deflater
Gets the current adler checksum of the data that was processed so far.
getAdler() - Method in class net.sf.jazzlib.Inflater
Gets the adler checksum.
getAll() - Method in class nl.siegmann.epublib.domain.Resources
 
getAllHrefs() - Method in class nl.siegmann.epublib.domain.Resources
All resource hrefs
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.
getBookProcessor() - Method in class nl.siegmann.epublib.epub.EpubWriter
 
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.
getChecksum() - Method in class net.sf.jazzlib.CheckedInputStream
Returns the Checksum object used.
getChecksum() - Method in class net.sf.jazzlib.CheckedOutputStream
Returns the Checksum object used.
getChildren() - Method in class nl.siegmann.epublib.domain.TOCReference
 
getCode() - Method in enum nl.siegmann.epublib.domain.Relator
 
getComment() - Method in class net.sf.jazzlib.ZipEntry
Gets the comment.
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.
getCompressedSize() - Method in class net.sf.jazzlib.ZipEntry
Gets the size of the compressed data.
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.
getCoverPage() - Method in class nl.siegmann.epublib.domain.Book
The book's cover page as a Resource.
getCoverPage() - Method in class nl.siegmann.epublib.domain.Guide
The coverpage of the book.
getCoverReference() - Method in class nl.siegmann.epublib.domain.Guide
 
getCrc() - Method in class net.sf.jazzlib.ZipEntry
Gets the crc of the uncompressed data.
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.LazyResource
The contents of the resource as a byte[] If this resource was lazy-loaded and the data was not yet loaded, it will be loaded into memory at this point.
getData() - Method in class nl.siegmann.epublib.domain.Resource
The contents of the resource as a byte[]
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.
getEntityResolver() - Static method in class nl.siegmann.epublib.epub.EpubProcessorSupport
Gets an EntityResolver that loads dtd's and such from the epublib classpath.
getEntry(String) - Method in class net.sf.jazzlib.ZipFile
Searches for a zip entry in this archive with the given name.
getEvent() - Method in class nl.siegmann.epublib.domain.Date
 
getExtensions() - Method in class nl.siegmann.epublib.domain.MediaType
 
getExtra() - Method in class net.sf.jazzlib.ZipEntry
Gets the extra data.
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.
getGuideReferencesByType(String) - Method in class nl.siegmann.epublib.domain.Guide
A list of all GuideReferences that have the given referenceTypeName (ignoring case).
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.
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 character 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(ZipEntry) - Method in class net.sf.jazzlib.ZipFile
Creates an input stream reading the given zip entry as uncompressed data.
getInputStream() - Method in class nl.siegmann.epublib.domain.LazyResource
Gets the contents of the Resource as an InputStream.
getInputStream() - Method in class nl.siegmann.epublib.domain.Resource
Gets the contents of the Resource as an InputStream.
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
 
getMetaAttribute(String) - Method in class nl.siegmann.epublib.domain.Metadata
 
getMetadata() - Method in class nl.siegmann.epublib.domain.Book
The Book's metadata (titles, authors, etc)
getMethod() - Method in class net.sf.jazzlib.ZipEntry
Gets the compression method.
getName() - Method in class net.sf.jazzlib.ZipEntry
Returns the entry name.
getName() - Method in class net.sf.jazzlib.ZipFile
Returns the (path) name of this zip file.
getName() - Method in enum nl.siegmann.epublib.domain.ManifestItemProperties
 
getName() - Method in enum nl.siegmann.epublib.domain.ManifestItemRefProperties
 
getName() - Method in interface nl.siegmann.epublib.domain.ManifestProperties
 
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
 
getNextEntry() - Method in class net.sf.jazzlib.ZipInputStream
Open the next entry from the zip archive, and return its description.
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
 
getRemaining() - Method in class net.sf.jazzlib.Inflater
Gets the number of unprocessed input.
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
 
getSize() - Method in class net.sf.jazzlib.ZipEntry
Gets the size of the uncompressed data.
getSize() - Method in class nl.siegmann.epublib.domain.LazyResource
Returns the size of this resource in bytes.
getSize() - Method in class nl.siegmann.epublib.domain.Resource
Returns the size of this resource in bytes.
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
 
getSymbol(StreamManipulator) - Method in class net.sf.jazzlib.InflaterHuffmanTree
Reads the next symbol from input.
getTableOfContents() - Method in class nl.siegmann.epublib.domain.Book
The Table of Contents of the book.
getTime() - Method in class net.sf.jazzlib.ZipEntry
Gets the time of last modification of the entry.
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
If the title is found by scanning the underlying html document then it is cached here.
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.
getTotalIn() - Method in class net.sf.jazzlib.Deflater
Gets the number of input bytes processed so far.
getTotalIn() - Method in class net.sf.jazzlib.Inflater
Gets the total number of processed compressed input bytes.
getTotalOut() - Method in class net.sf.jazzlib.Deflater
Gets the number of output bytes so far.
getTotalOut() - Method in class net.sf.jazzlib.Inflater
Gets the total number of output bytes returned by inflate().
getType() - Method in class nl.siegmann.epublib.domain.GuideReference
 
getTypes() - Method in class nl.siegmann.epublib.domain.Metadata
 
getValue() - Method in class net.sf.jazzlib.Adler32
Returns the Adler32 data checksum computed so far.
getValue() - Method in interface net.sf.jazzlib.Checksum
Returns the data checksum computed so far.
getValue() - Method in class net.sf.jazzlib.CRC32
Returns the CRC32 data checksum computed so far.
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.
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
 
GZIP_MAGIC - Static variable in class net.sf.jazzlib.GZIPInputStream
The magic number found at the start of a GZIP stream.
GZIPInputStream - Class in net.sf.jazzlib
This filter stream is used to decompress a "GZIP" format stream.
GZIPInputStream(InputStream) - Constructor for class net.sf.jazzlib.GZIPInputStream
Creates a GZIPInputStream with the default buffer size.
GZIPInputStream(InputStream, int) - Constructor for class net.sf.jazzlib.GZIPInputStream
Creates a GZIPInputStream with the specified buffer size.
GZIPOutputStream - Class in net.sf.jazzlib
This filter stream is used to compress a stream into a "GZIP" stream.
GZIPOutputStream(OutputStream) - Constructor for class net.sf.jazzlib.GZIPOutputStream
 
GZIPOutputStream(OutputStream, int) - Constructor for class net.sf.jazzlib.GZIPOutputStream
Creates a GZIPOutputStream with the specified buffer size

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 net.sf.jazzlib.ZipEntry
Gets the hashCode of this ZipEntry.
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
Gets the hashCode of the Resource's href.
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
 
HUFFMAN_ONLY - Static variable in class net.sf.jazzlib.Deflater
This strategy will not look for string repetitions at all.

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
inf - Variable in class net.sf.jazzlib.InflaterInputStream
Decompressor for this filter
inflate(byte[]) - Method in class net.sf.jazzlib.Inflater
Inflates the compressed stream to the output buffer.
inflate(byte[], int, int) - Method in class net.sf.jazzlib.Inflater
Inflates the compressed stream to the output buffer.
Inflater - Class in net.sf.jazzlib
Inflater is used to decompress data that has been compressed according to the "deflate" standard described in rfc1950.
Inflater() - Constructor for class net.sf.jazzlib.Inflater
Creates a new inflater.
Inflater(boolean) - Constructor for class net.sf.jazzlib.Inflater
Creates a new inflater.
InflaterHuffmanTree - Class in net.sf.jazzlib
 
InflaterHuffmanTree(byte[]) - Constructor for class net.sf.jazzlib.InflaterHuffmanTree
Constructs a Huffman tree from the array of code lengths.
InflaterInputStream - Class in net.sf.jazzlib
This filter stream is used to decompress data compressed in the "deflate" format.
InflaterInputStream(InputStream) - Constructor for class net.sf.jazzlib.InflaterInputStream
Create an InflaterInputStream with the default decompresseor and a default buffer size.
InflaterInputStream(InputStream, Inflater) - Constructor for class net.sf.jazzlib.InflaterInputStream
Create an InflaterInputStream with the specified decompresseor and a default buffer size.
InflaterInputStream(InputStream, Inflater, int) - Constructor for class net.sf.jazzlib.InflaterInputStream
Create an InflaterInputStream with the specified decompresseor and a specified buffer size.
initBook(Book) - Method in class nl.siegmann.epublib.browsersupport.NavigationHistory
 
initialize() - Method in class nl.siegmann.epublib.domain.LazyResource
Initializes the resource by loading its data into memory.
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.
isDirectory() - Method in class net.sf.jazzlib.ZipEntry
Gets true, if the entry is a directory.
isEmpty() - Method in class nl.siegmann.epublib.domain.Resources
 
isEmpty() - Method in class nl.siegmann.epublib.domain.Spine
Whether the spine has any references
isEmpty(Collection<?>) - Static method in class nl.siegmann.epublib.util.CollectionUtil
Whether the given collection is null or has no elements.
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
 
isInitialized() - Method in class nl.siegmann.epublib.domain.LazyResource
Returns if the data for this resource has been loaded into memory.
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

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

L

language - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.DCTags
 
LazyResource - Class in nl.siegmann.epublib.domain
A Resource that loads its data only on-demand.
LazyResource(String, long, String) - Constructor for class nl.siegmann.epublib.domain.LazyResource
Creates a Lazy resource, by not actually loading the data for this entry.
LazyResource(InputStream, String, int, String) - Constructor for class nl.siegmann.epublib.domain.LazyResource
Creates a Resource that tries to load the data, but falls back to lazy loading.
len - Variable in class net.sf.jazzlib.InflaterInputStream
Size of buffer
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
 
loadResources(ZipFile, String, List<MediaType>) - Static method in class nl.siegmann.epublib.epub.ResourcesLoader
Loads the entries of the zipFile as resources.
loadResources(InputStream, String) - Static method in class nl.siegmann.epublib.epub.ResourcesLoader
 
loadResources(ZipInputStream, String) - Static method in class nl.siegmann.epublib.epub.ResourcesLoader
Loads all entries from the ZipInputStream as Resources.
loadResources(ZipFile, String) - Static method in class nl.siegmann.epublib.epub.ResourcesLoader
Loads all entries from the ZipInputStream as Resources.
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
 
ManifestItemProperties - Enum in nl.siegmann.epublib.domain
 
ManifestItemRefProperties - Enum in nl.siegmann.epublib.domain
 
ManifestProperties - Interface in nl.siegmann.epublib.domain
 
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.
MP3 - Static variable in class nl.siegmann.epublib.service.MediatypeService
 
MP4 - Static variable in class nl.siegmann.epublib.service.MediatypeService
 

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
 
needsDictionary() - Method in class net.sf.jazzlib.Inflater
Returns true, if a preset dictionary is needed to inflate the input.
needsInput() - Method in class net.sf.jazzlib.Deflater
Returns true, if the input buffer is empty.
needsInput() - Method in class net.sf.jazzlib.Inflater
Returns true, if the input buffer is empty.
net.sf.jazzlib - package net.sf.jazzlib
 
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
 
NO_COMPRESSION - Static variable in class net.sf.jazzlib.Deflater
This level won't compress at all but output uncompressed blocks.
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

OGG - Static variable in class nl.siegmann.epublib.service.MediatypeService
 
OPEN_DELETE - Static variable in class net.sf.jazzlib.ZipFile
Mode flag to delete a zip file after reading.
OPEN_READ - Static variable in class net.sf.jazzlib.ZipFile
Mode flag to open a zip file for reading.
OPENTYPE - Static variable in class nl.siegmann.epublib.service.MediatypeService
 
originalHref - Variable in class nl.siegmann.epublib.domain.Resource
 
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
 
PLS - Static variable in class nl.siegmann.epublib.service.MediatypeService
 
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
 
property - Static variable in interface nl.siegmann.epublib.epub.PackageDocumentBase.OPFAttributes
 
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
 
putNextEntry(ZipEntry) - Method in class net.sf.jazzlib.ZipOutputStream
Starts a new Zip entry.

R

read() - Method in class net.sf.jazzlib.CheckedInputStream
Reads one byte, updates the checksum and returns the read byte (or -1 when the end of file was reached).
read(byte[], int, int) - Method in class net.sf.jazzlib.CheckedInputStream
Reads at most len bytes in the supplied buffer and updates the checksum with it.
read(byte[], int, int) - Method in class net.sf.jazzlib.GZIPInputStream
Reads in GZIP-compressed data and stores it in uncompressed form into an array of bytes.
read() - Method in class net.sf.jazzlib.InflaterInputStream
Reads one byte of decompressed data.
read(byte[], int, int) - Method in class net.sf.jazzlib.InflaterInputStream
Decompresses data into the byte array
read() - Method in class net.sf.jazzlib.ZipInputStream
Reads a byte from the current zip entry.
read(byte[], int, int) - Method in class net.sf.jazzlib.ZipInputStream
Reads a block of bytes from the current zip entry.
read(Book, EpubReader) - Static method in class nl.siegmann.epublib.epub.NCXDocument
 
read(Resource, EpubReader, Book, Resources) - 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(ZipFile) - 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
 
readEpub(ZipFile, String) - Method in class nl.siegmann.epublib.epub.EpubReader
 
readEpub(Resources) - Method in class nl.siegmann.epublib.epub.EpubReader
 
readEpub(Resources, Book) - Method in class nl.siegmann.epublib.epub.EpubReader
 
readEpubLazy(ZipFile, String) - Method in class nl.siegmann.epublib.epub.EpubReader
Reads this EPUB without loading any resources into memory.
readEpubLazy(ZipFile, String, List<MediaType>) - Method in class nl.siegmann.epublib.epub.EpubReader
Reads this EPUB without loading all resources into memory.
recode(String, String, byte[]) - Static method in class nl.siegmann.epublib.util.ResourceUtil
Converts a given string from given input character encoding to the requested output character encoding.
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 net.sf.jazzlib.Adler32
Resets the Adler32 checksum to the initial value.
reset() - Method in interface net.sf.jazzlib.Checksum
Resets the data checksum as if no update was ever called.
reset() - Method in class net.sf.jazzlib.CRC32
Resets the CRC32 data checksum as if no update was ever called.
reset() - Method in class net.sf.jazzlib.Deflater
Resets the deflater.
reset() - Method in class net.sf.jazzlib.Inflater
Resets the inflater so that a new stream can be decompressed.
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
Creates an empty Resource with the given href.
Resource(byte[], MediaType) - Constructor for class nl.siegmann.epublib.domain.Resource
Creates a Resource with the given data and MediaType.
Resource(byte[], String) - Constructor for class nl.siegmann.epublib.domain.Resource
Creates a resource with the given data at the specified href.
Resource(Reader, String) - Constructor for class nl.siegmann.epublib.domain.Resource
Creates a resource with the data from the given Reader at the specified href.
Resource(InputStream, String) - Constructor for class nl.siegmann.epublib.domain.Resource
Creates a resource with the data from the given InputStream at the specified href.
Resource(String, byte[], String, MediaType) - Constructor for class nl.siegmann.epublib.domain.Resource
Creates a resource with the given id, data, mediatype at the specified href.
Resource(String, byte[], String, MediaType, String) - Constructor for class nl.siegmann.epublib.domain.Resource
Creates a resource with the given id, data, mediatype at the specified href.
resource - Variable in class nl.siegmann.epublib.domain.ResourceReference
 
ResourceInputStream - Class in nl.siegmann.epublib.domain
A wrapper class for closing a ZipFile object when the InputStream derived from it is closed.
ResourceInputStream(InputStream, ZipFile) - Constructor for class nl.siegmann.epublib.domain.ResourceInputStream
Constructor.
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
 
ResourcesLoader - Class in nl.siegmann.epublib.epub
Loads Resources from inputStreams, ZipFiles, etc
ResourcesLoader() - Constructor for class nl.siegmann.epublib.epub.ResourcesLoader
 
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
 
setBookProcessor(BookProcessor) - Method in class nl.siegmann.epublib.epub.EpubWriter
 
setChildren(List<TOCReference>) - Method in class nl.siegmann.epublib.domain.TOCReference
 
setComment(String) - Method in class net.sf.jazzlib.ZipEntry
Sets the entry comment.
setComment(String) - Method in class net.sf.jazzlib.ZipOutputStream
Set the zip file comment.
setCompressedSize(long) - Method in class net.sf.jazzlib.ZipEntry
Sets the size of the compressed data.
setContributors(List<Author>) - Method in class nl.siegmann.epublib.domain.Metadata
 
setCoverImage(Resource) - Method in class nl.siegmann.epublib.domain.Book
 
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
 
setCrc(long) - Method in class net.sf.jazzlib.ZipEntry
Sets the crc of the uncompressed data.
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
Sets the data of the 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
 
setDictionary(byte[]) - Method in class net.sf.jazzlib.Deflater
Sets the dictionary which should be used in the deflate process.
setDictionary(byte[], int, int) - Method in class net.sf.jazzlib.Deflater
Sets the dictionary which should be used in the deflate process.
setDictionary(byte[]) - Method in class net.sf.jazzlib.Inflater
Sets the preset dictionary.
setDictionary(byte[], int, int) - Method in class net.sf.jazzlib.Inflater
Sets the preset dictionary.
setEvent(Date.Event) - Method in class nl.siegmann.epublib.domain.Date
 
setExtra(byte[]) - Method in class net.sf.jazzlib.ZipEntry
Sets the extra data.
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
Sets the Resource's href.
setId(String) - Method in class nl.siegmann.epublib.domain.Resource
Sets the Resource's id: Make sure it is unique and a valid identifier.
setIdentifiers(List<Identifier>) - Method in class nl.siegmann.epublib.domain.Metadata
 
setInput(byte[]) - Method in class net.sf.jazzlib.Deflater
Sets the data which should be compressed next.
setInput(byte[], int, int) - Method in class net.sf.jazzlib.Deflater
Sets the data which should be compressed next.
setInput(byte[]) - Method in class net.sf.jazzlib.Inflater
Sets the input.
setInput(byte[], int, int) - Method in class net.sf.jazzlib.Inflater
Sets the input.
setInputEncoding(String) - Method in class nl.siegmann.epublib.domain.Resource
Sets the Resource's input character encoding.
setLanguage(String) - Method in class nl.siegmann.epublib.domain.Metadata
 
setLastname(String) - Method in class nl.siegmann.epublib.domain.Author
 
setLevel(int) - Method in class net.sf.jazzlib.Deflater
Sets the compression level.
setLevel(int) - Method in class net.sf.jazzlib.ZipOutputStream
Sets default compression level.
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
 
setMetaAttributes(Map<String, String>) - Method in class nl.siegmann.epublib.domain.Metadata
 
setMetadata(Metadata) - Method in class nl.siegmann.epublib.domain.Book
 
setMethod(int) - Method in class net.sf.jazzlib.ZipEntry
Sets the compression method.
setMethod(int) - Method in class net.sf.jazzlib.ZipOutputStream
Sets default compression method.
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
 
setSize(long) - Method in class net.sf.jazzlib.ZipEntry
Sets the size of the uncompressed data.
setSpine(Spine) - Method in class nl.siegmann.epublib.domain.Book
 
setSpineReferences(List<SpineReference>) - Method in class nl.siegmann.epublib.domain.Spine
 
setStrategy(int) - Method in class net.sf.jazzlib.Deflater
Sets the compression strategy.
setSubjects(List<String>) - Method in class nl.siegmann.epublib.domain.Metadata
 
setTableOfContents(TableOfContents) - Method in class nl.siegmann.epublib.domain.Book
 
setTime(long) - Method in class net.sf.jazzlib.ZipEntry
Sets the time of last modification of the entry.
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 net.sf.jazzlib.ZipFile
Returns the number of entries in this zip file.
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 net.sf.jazzlib.CheckedInputStream
Skips n bytes by reading them in a temporary buffer and updating the the checksum with that buffer.
skip(long) - Method in class net.sf.jazzlib.InflaterInputStream
Skip specified number of bytes of uncompressed data
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.
SMIL - Static variable in class nl.siegmann.epublib.service.MediatypeService
 
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
 
STORED - Static variable in class net.sf.jazzlib.ZipEntry
Compression method.
STORED - Static variable in class net.sf.jazzlib.ZipOutputStream
Compression method.
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[]
toByteArray(InputStream, int) - Static method in class nl.siegmann.epublib.util.IOUtil
Reads data from the InputStream, using the specified buffer size.
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 net.sf.jazzlib.ZipEntry
Gets the string representation of this ZipEntry.
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
 
update(int) - Method in class net.sf.jazzlib.Adler32
Updates the checksum with the byte b.
update(byte[]) - Method in class net.sf.jazzlib.Adler32
Updates the checksum with the bytes taken from the array.
update(byte[], int, int) - Method in class net.sf.jazzlib.Adler32
Updates the checksum with the bytes taken from the array.
update(int) - Method in interface net.sf.jazzlib.Checksum
Adds one byte to the data checksum.
update(byte[], int, int) - Method in interface net.sf.jazzlib.Checksum
Adds the byte array to the data checksum.
update(int) - Method in class net.sf.jazzlib.CRC32
Updates the checksum with the int bval.
update(byte[], int, int) - Method in class net.sf.jazzlib.CRC32
Adds the byte array to the data checksum.
update(byte[]) - Method in class net.sf.jazzlib.CRC32
Adds the complete byte array to the data checksum.
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.ManifestItemProperties
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum nl.siegmann.epublib.domain.ManifestItemRefProperties
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.ManifestItemProperties
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.ManifestItemRefProperties
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

WOFF - Static variable in class nl.siegmann.epublib.service.MediatypeService
 
write(int) - Method in class net.sf.jazzlib.CheckedOutputStream
Writes one byte to the OutputStream and updates the Checksum.
write(byte[], int, int) - Method in class net.sf.jazzlib.CheckedOutputStream
Writes the byte array to the OutputStream and updates the Checksum.
write(int) - Method in class net.sf.jazzlib.DeflaterOutputStream
Writes a single byte to the compressed output stream.
write(byte[], int, int) - Method in class net.sf.jazzlib.DeflaterOutputStream
Writes a len bytes from an array to the compressed stream.
write(byte[], int, int) - Method in class net.sf.jazzlib.GZIPOutputStream
 
write(byte[], int, int) - Method in class net.sf.jazzlib.ZipOutputStream
Writes the given buffer to the current entry.
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.
XPGT - Static variable in class nl.siegmann.epublib.service.MediatypeService
 

Z

ZipEntry - Class in net.sf.jazzlib
This class represents a member of a zip archive.
ZipEntry(String) - Constructor for class net.sf.jazzlib.ZipEntry
Creates a zip entry with the given name.
ZipEntry(ZipEntry) - Constructor for class net.sf.jazzlib.ZipEntry
Creates a copy of the given zip entry.
ZipException - Exception in net.sf.jazzlib
Thrown during the creation or input of a zip file.
ZipException() - Constructor for exception net.sf.jazzlib.ZipException
Create an exception without a message.
ZipException(String) - Constructor for exception net.sf.jazzlib.ZipException
Create an exception with a message.
ZipFile - Class in net.sf.jazzlib
This class represents a Zip archive.
ZipFile(String) - Constructor for class net.sf.jazzlib.ZipFile
Opens a Zip file with the given name for reading.
ZipFile(File) - Constructor for class net.sf.jazzlib.ZipFile
Opens a Zip file reading the given File.
ZipFile(File, int) - Constructor for class net.sf.jazzlib.ZipFile
Opens a Zip file reading the given File in the given mode.
ZipInputStream - Class in net.sf.jazzlib
This is a FilterInputStream that reads the files in an zip archive one after another.
ZipInputStream(InputStream) - Constructor for class net.sf.jazzlib.ZipInputStream
Creates a new Zip input stream, reading a zip archive.
ZipOutputStream - Class in net.sf.jazzlib
This is a FilterOutputStream that writes the files into a zip archive one after another.
ZipOutputStream(OutputStream) - Constructor for class net.sf.jazzlib.ZipOutputStream
Creates a new Zip output stream, writing a zip archive.
A B C D E F G H I J L M N O P R S T U V W X Z 
Skip navigation links

Copyright © 2009–2017. All rights reserved.