Package com.adobe.epubcheck.api

Class MasterReport

java.lang.Object

com.adobe.epubcheck.api.MasterReport

All Implemented Interfaces:

LocalizableReport, Report

Direct Known Subclasses:

CheckingReport, DefaultReportImpl, QuietReport, WriterReportImpl, XmlReportAbstract

public abstract class MasterReport
extends java.lang.Object
implements LocalizableReport

Reports are derived from this so that we can test for message Id coverage as well as have a centralized location for severity reporting level testing.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Set<MessageId>	allReportedMessageIds
(package private) java.lang.String	customMessageFileName
private MessageDictionary	dictionary
private java.lang.String	ePubName
private int	errorCount
private int	fatalErrorCount
private int	infoCount
private Messages	messages
private int	reportingLevel
private int	usageCount
private int	warningCount

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MasterReport()	Creates a report with a new Messages instance and sets the locale held in LocaleHolder to the default locale.
protected	MasterReport(boolean setLocale)	Creates a report with a new Messages instance and sets the locale held in LocaleHolder to the default locale only if the given flag is true.

Method Summary

Modifier and Type	Method	Description
void	close()
java.lang.String	getCustomMessageFile()
MessageDictionary	getDictionary()
java.lang.String	getEpubFileName()
int	getErrorCount()
int	getFatalErrorCount()
int	getInfoCount()
java.util.Locale	getLocale()	Gets the locale to use in the report's messages
Messages	getMessages()
int	getReportingLevel()
int	getUsageCount()
int	getWarningCount()
void	message(MessageId id, EPUBLocation location, java.lang.Object... args)	Called when a violation of the standard is found in epub.
private void	reportMessageId(MessageId id)
void	setCustomMessageFile(java.lang.String customMessageFileName)
void	setEpubFileName(java.lang.String value)
void	setLocale(java.util.Locale locale)	Sets the locale to use in the report's messages
void	setOverrideFile(java.io.File overrideFile)
void	setReportingLevel(int reportingLevel)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.epubcheck.api.Report

generate, info, initialize, message

Field Detail

allReportedMessageIds

public static java.util.Set<MessageId> allReportedMessageIds

errorCount

private int errorCount

warningCount

private int warningCount

fatalErrorCount

private int fatalErrorCount

usageCount

private int usageCount

infoCount

private int infoCount

reportingLevel

private int reportingLevel

ePubName

private java.lang.String ePubName

dictionary

private MessageDictionary dictionary

messages

private Messages messages

customMessageFileName

java.lang.String customMessageFileName

Constructor Detail

MasterReport

protected MasterReport()

Creates a report with a new Messages instance and sets the locale held in LocaleHolder to the default locale.

MasterReport

protected MasterReport(boolean setLocale)

Creates a report with a new Messages instance and sets the locale held in LocaleHolder to the default locale only if the given flag is true.

Parameters:

setLocale - whether to update the locale held in LocaleHolder

Method Detail

getDictionary

public MessageDictionary getDictionary()

Specified by:

getDictionary in interface Report

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: LocalizableReport

Sets the locale to use in the report's messages

Specified by:

setLocale in interface LocalizableReport

getLocale

public java.util.Locale getLocale()

Description copied from interface: LocalizableReport

Gets the locale to use in the report's messages

Specified by:

getLocale in interface LocalizableReport

getMessages

public Messages getMessages()

setOverrideFile

public void setOverrideFile(java.io.File overrideFile)

Specified by:

setOverrideFile in interface Report

reportMessageId

private void reportMessageId(MessageId id)

message

public void message(MessageId id,
                    EPUBLocation location,
                    java.lang.Object... args)

Description copied from interface: Report

Called when a violation of the standard is found in epub.

Specified by:

message in interface Report

Parameters:

id - Id of the message being reported

location - location information for the message

args - Arguments referenced by the format string for the message.

setCustomMessageFile

public void setCustomMessageFile(java.lang.String customMessageFileName)

Specified by:

setCustomMessageFile in interface Report

getCustomMessageFile

public java.lang.String getCustomMessageFile()

Specified by:

getCustomMessageFile in interface Report

getReportingLevel

public int getReportingLevel()

Specified by:

getReportingLevel in interface Report

setReportingLevel

public void setReportingLevel(int reportingLevel)

Specified by:

setReportingLevel in interface Report

getEpubFileName

public java.lang.String getEpubFileName()

Specified by:

getEpubFileName in interface Report

setEpubFileName

public void setEpubFileName(java.lang.String value)

Specified by:

setEpubFileName in interface Report

getErrorCount

public int getErrorCount()

Specified by:

getErrorCount in interface Report

getWarningCount

public int getWarningCount()

Specified by:

getWarningCount in interface Report

getFatalErrorCount

public int getFatalErrorCount()

Specified by:

getFatalErrorCount in interface Report

getInfoCount

public int getInfoCount()

Specified by:

getInfoCount in interface Report

getUsageCount

public int getUsageCount()

Specified by:

getUsageCount in interface Report

close

public void close()

Specified by:

close in interface Report