Class EpubCheck

java.lang.Object

com.adobe.epubcheck.api.EpubCheck

All Implemented Interfaces:

Checker

public class EpubCheck
extends Object
implements Checker

Public interface to epub validator.

Field Summary

Fields

Modifier and Type	Field	Description
private static String	BUILD_DATE
private final File	epubFile
private final EPUBProfile	profile
private final Report	report
private static String	VERSION

Constructor Summary

Constructors

Constructor	Description
EpubCheck(File epubFile)	Create an epub validator to validate the given file.
EpubCheck(File epubFile, Report report)	Create an epub validator to validate the given file and report issues to a given Report object.
EpubCheck(File epubFile, Report report, EPUBProfile profile)	Create an epub validator to validate the given file and report issues to a given Report object.
EpubCheck(File epubFile, PrintWriter out)	Create an epub validator to validate the given file.
EpubCheck(InputStream inputStream, Report report, String uri)
EpubCheck(InputStream inputStream, Report report, String uri, EPUBProfile profile)

Method Summary

Modifier and Type	Method	Description
static String	buildDate()
void	check()	Validate the file.
int	doValidate()
void	setLocale(Locale locale)	Allows for a per-instance override of the locale, if supported by the underlying Report.
static String	version()

Methods inherited from class Object

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

Field Details

VERSION

private static String VERSION

BUILD_DATE

private static String BUILD_DATE

epubFile

private final File epubFile

profile

private final EPUBProfile profile

report

private final Report report

Constructor Details

EpubCheck

public EpubCheck(File epubFile)

Create an epub validator to validate the given file. Issues will be reported to standard error.

EpubCheck

public EpubCheck(File epubFile,
 PrintWriter out)

Create an epub validator to validate the given file. Issues will be reported to the given PrintWriter.

EpubCheck

public EpubCheck(File epubFile,
 Report report)

Create an epub validator to validate the given file and report issues to a given Report object.

EpubCheck

public EpubCheck(File epubFile,
 Report report,
 EPUBProfile profile)

Create an epub validator to validate the given file and report issues to a given Report object. Can validate a specific EPUB profile (e.g. EDUPUB, DICT, IDX, etc).

EpubCheck

public EpubCheck(InputStream inputStream,
 Report report,
 String uri)

EpubCheck

public EpubCheck(InputStream inputStream,
 Report report,
 String uri,
 EPUBProfile profile)

Method Details

version

public static String version()

buildDate

public static String buildDate()

setLocale

public void setLocale(Locale locale)

Allows for a per-instance override of the locale, if supported by the underlying Report. Otherwise takes the default host locale.

Parameters:

locale - The overridden locale.

check

public void check()

Validate the file. Return true if no errors or warnings found.

Specified by:

check in interface Checker

doValidate

public int doValidate()