Class EpubChecker

java.lang.Object

com.adobe.epubcheck.tool.EpubChecker

public class EpubChecker
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) File	customMessageFile
(package private) boolean	displayHelp
(package private) boolean	displayVersion
private static final String	EPUBCHECK_CUSTOM_MESSAGE_FILE
(package private) boolean	expanded
(package private) boolean	failOnWarnings
(package private) File	fileOut
(package private) boolean	jsonOutput
(package private) boolean	keep
(package private) boolean	listChecks
(package private) File	listChecksOut
private Locale	locale
private Messages	messages
(package private) String	mode
private static final HashMap<OPSType,String>	modeMimeTypeMap
(package private) String	path
(package private) EPUBProfile	profile
(package private) int	reportingLevel
(package private) boolean	useCustomMessageFile
(package private) EPUBVersion	version
(package private) boolean	xmlOutput
(package private) boolean	xmpOutput

Constructor Summary

Constructors

Constructor	Description
EpubChecker()

Method Summary

Modifier and Type	Method	Description
private Report	createReport()
private void	displayHelp()	This method displays a short help message that describes the command-line usage of this tool
private void	displayVersion()	This method displays the EpubCheck version.
private void	dumpMessageDictionary(Report report)
Locale	getLocale()
private void	printEpubCheckCompleted(Report report)
private boolean	processArguments(String[] args)	This method iterates through all of the arguments passed to main to find accepted flags and the name of the file to check.
int	processEpubFile(String[] args)	Deprecated.
private int	processFile(Report report)
int	run(String[] args)
private void	setCustomMessageFileFromEnvironment()
(package private) int	validateFile(String path, EPUBVersion version, Report report, EPUBProfile profile)

Methods inherited from class Object

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

Field Details

path

String path

mode

String mode

profile

EPUBProfile profile

version

EPUBVersion version

expanded

boolean expanded

keep

boolean keep

jsonOutput

boolean jsonOutput

xmlOutput

boolean xmlOutput

xmpOutput

boolean xmpOutput

fileOut

File fileOut

listChecksOut

File listChecksOut

customMessageFile

File customMessageFile

listChecks

boolean listChecks

displayHelp

boolean displayHelp

displayVersion

boolean displayVersion

useCustomMessageFile

boolean useCustomMessageFile

failOnWarnings

boolean failOnWarnings

messages

private Messages messages

locale

private Locale locale

reportingLevel

int reportingLevel

modeMimeTypeMap

private static final HashMap<OPSType,String> modeMimeTypeMap

EPUBCHECK_CUSTOM_MESSAGE_FILE

private static final String EPUBCHECK_CUSTOM_MESSAGE_FILE

See Also:

• Constant Field Values

Constructor Details

EpubChecker

public EpubChecker()

Method Details

getLocale

public Locale getLocale()

run

public int run(String[] args)

processEpubFile

@Deprecated
public int processEpubFile(String[] args)

Deprecated.

validateFile

int validateFile(String path,
 EPUBVersion version,
 Report report,
 EPUBProfile profile)

processFile

private int processFile(Report report)

printEpubCheckCompleted

private void printEpubCheckCompleted(Report report)

dumpMessageDictionary

private void dumpMessageDictionary(Report report)
                            throws IOException

Throws:

IOException

createReport

private Report createReport()
                     throws IOException

Throws:

IOException

processArguments

private boolean processArguments(String[] args)

This method iterates through all of the arguments passed to main to find accepted flags and the name of the file to check. This method returns the last argument that ends with ".epub" (which is assumed to be the file to check) Here are the currently accepted flags:

-? or -help = display usage instructions
-v or -version = display tool version number

Parameters:

args - String[] containing arguments passed to main

Returns:

the name of the file to check

setCustomMessageFileFromEnvironment

private void setCustomMessageFileFromEnvironment()

displayHelp

private void displayHelp()

This method displays a short help message that describes the command-line usage of this tool

displayVersion

private void displayVersion()

This method displays the EpubCheck version.