Package com.adobe.epubcheck.api

Interface Report

All Known Subinterfaces:

LocalizableReport

All Known Implementing Classes:

CheckingReport, DefaultReportImpl, MasterReport, QuietReport, WriterReportImpl, XmlReportAbstract, XmlReportImpl, XmpReportImpl

public interface Report

Interface that is used to report issues found in epub.

Method Summary

Modifier and Type	Method	Description
void	close()
int	generate()	Called to create a report after the checks have been made
java.lang.String	getCustomMessageFile()
MessageDictionary	getDictionary()
java.lang.String	getEpubFileName()
int	getErrorCount()
int	getFatalErrorCount()
int	getInfoCount()
int	getReportingLevel()
int	getUsageCount()
int	getWarningCount()
void	info(java.lang.String resource, FeatureEnum feature, java.lang.String value)	Called when when a feature is found in epub.
void	initialize()	Called when a report if first created
void	message(MessageId id, EPUBLocation location, java.lang.Object... args)	Called when a violation of the standard is found in epub.
void	message(Message message, EPUBLocation location, java.lang.Object... args)	Called when a violation of the standard is found in epub.
void	setCustomMessageFile(java.lang.String customMessageFileName)
void	setEpubFileName(java.lang.String value)
void	setOverrideFile(java.io.File customMessageFile)
void	setReportingLevel(int level)

Method Detail

message

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

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

Parameters:

id - Id of the message being reported

location - location information for the message

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

message

void message(Message message,
             EPUBLocation location,
             java.lang.Object... args)

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

Parameters:

message - The message being reported

location - location information for the message

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

info

void info(java.lang.String resource,
          FeatureEnum feature,
          java.lang.String value)

Called when when a feature is found in epub.

Parameters:

resource - name of the resource in the epub zip container that has this feature or null if the feature is on the container level.

feature - a keyword to know what kind of feature has been found

value - value found

getErrorCount

int getErrorCount()

getWarningCount

int getWarningCount()

getFatalErrorCount

int getFatalErrorCount()

getInfoCount

int getInfoCount()

getUsageCount

int getUsageCount()

generate

int generate()

Called to create a report after the checks have been made

initialize

void initialize()

Called when a report if first created

setEpubFileName

void setEpubFileName(java.lang.String value)

getEpubFileName

java.lang.String getEpubFileName()

setCustomMessageFile

void setCustomMessageFile(java.lang.String customMessageFileName)

getCustomMessageFile

java.lang.String getCustomMessageFile()

getReportingLevel

int getReportingLevel()

setReportingLevel

void setReportingLevel(int level)

close

void close()

setOverrideFile

void setOverrideFile(java.io.File customMessageFile)

getDictionary

MessageDictionary getDictionary()