Package nl.siegmann.epublib.epub

Class EpubReader

java.lang.Object

nl.siegmann.epublib.epub.EpubReader

public class EpubReader
extends Object

Reads an epub file.

Field Summary

Fields

Modifier and Type	Field	Description
private BookProcessor	bookProcessor
private static final org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
EpubReader()

Method Summary

Modifier and Type	Method	Description
private String	getPackageResourceHref(Resources resources)
private void	handleMimeType(Book result, Resources resources)
private Book	postProcessBook(Book book)
private Resource	processNcxResource(Resource packageResource, Book book)
private Resource	processPackageResource(String packageResourceHref, Book book, Resources resources)
Book	readEpub(InputStream in)
Book	readEpub(InputStream in, String encoding)	Read epub from inputstream
Book	readEpub(ZipFile zipfile)
Book	readEpub(ZipFile in, String encoding)
Book	readEpub(ZipInputStream in)
Book	readEpub(ZipInputStream in, String encoding)
Book	readEpub(Resources resources)
Book	readEpub(Resources resources, Book result)
Book	readEpubLazy(ZipFile zipFile, String encoding)	Reads this EPUB without loading any resources into memory.
Book	readEpubLazy(ZipFile zipFile, String encoding, List<MediaType> lazyLoadedTypes)	Reads this EPUB without loading all resources into memory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

private static final org.slf4j.Logger log

bookProcessor

private BookProcessor bookProcessor

Constructor Details

EpubReader

public EpubReader()

Method Details

readEpub

public Book readEpub(InputStream in)
              throws IOException

Throws:

IOException

readEpub

public Book readEpub(ZipInputStream in)
              throws IOException

Throws:

IOException

readEpub

public Book readEpub(ZipFile zipfile)
              throws IOException

Throws:

IOException

readEpub

public Book readEpub(InputStream in,
 String encoding)
              throws IOException

Read epub from inputstream

Parameters:

in - the inputstream from which to read the epub

encoding - the encoding to use for the html files within the epub

Returns:

the Book as read from the inputstream

Throws:

IOException

readEpubLazy

public Book readEpubLazy(ZipFile zipFile,
 String encoding)
                  throws IOException

Reads this EPUB without loading any resources into memory.

Parameters:

zipFile - the file to load

encoding - the encoding for XHTML files

Returns:

this Book without loading all resources into memory.

Throws:

IOException

readEpub

public Book readEpub(ZipInputStream in,
 String encoding)
              throws IOException

Throws:

IOException

readEpub

public Book readEpub(ZipFile in,
 String encoding)
              throws IOException

Throws:

IOException

readEpubLazy

public Book readEpubLazy(ZipFile zipFile,
 String encoding,
 List<MediaType> lazyLoadedTypes)
                  throws IOException

Reads this EPUB without loading all resources into memory.

Parameters:

zipFile - the file to load

encoding - the encoding for XHTML files

lazyLoadedTypes - a list of the MediaType to load lazily

Returns:

this Book without loading all resources into memory.

Throws:

IOException

readEpub

public Book readEpub(Resources resources)
              throws IOException

Throws:

IOException

readEpub

public Book readEpub(Resources resources,
 Book result)
              throws IOException

Throws:

IOException

postProcessBook

private Book postProcessBook(Book book)

processNcxResource

private Resource processNcxResource(Resource packageResource,
 Book book)

processPackageResource

private Resource processPackageResource(String packageResourceHref,
 Book book,
 Resources resources)

getPackageResourceHref

private String getPackageResourceHref(Resources resources)

handleMimeType

private void handleMimeType(Book result,
 Resources resources)