Package com.adobe.epubcheck.util

Class WriterReportImpl

java.lang.Object

com.adobe.epubcheck.api.MasterReport

com.adobe.epubcheck.util.WriterReportImpl

All Implemented Interfaces:

LocalizableReport, Report

public class WriterReportImpl
extends MasterReport

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static boolean	DEBUG
(package private) java.io.PrintWriter	out
(package private) boolean	quiet

Fields inherited from class com.adobe.epubcheck.api.MasterReport

allReportedMessageIds

Constructor Summary

Constructors

Constructor	Description
WriterReportImpl(java.io.PrintWriter out)
WriterReportImpl(java.io.PrintWriter out, java.lang.String info)
WriterReportImpl(java.io.PrintWriter out, java.lang.String info, boolean quiet)

Method Summary

Modifier and Type	Method	Description
(package private) void	error(java.lang.String resource, int line, int column, java.lang.String message)
(package private) void	fatalError(java.lang.String resource, int line, int column, java.lang.String message)
(package private) java.lang.String	fixMessage(java.lang.String message)
int	generate()	Called to create a report after the checks have been made
void	hint(java.lang.String resource, int line, int column, java.lang.String message)
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(Message message, EPUBLocation location, java.lang.Object... args)	Called when a violation of the standard is found in epub.
(package private) void	warning(java.lang.String resource, int line, int column, java.lang.String message)

Methods inherited from class com.adobe.epubcheck.api.MasterReport

close, getCustomMessageFile, getDictionary, getEpubFileName, getErrorCount, getFatalErrorCount, getInfoCount, getLocale, getMessages, getReportingLevel, getUsageCount, getWarningCount, message, setCustomMessageFile, setEpubFileName, setLocale, setOverrideFile, setReportingLevel

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

static boolean DEBUG

quiet

boolean quiet

out

final java.io.PrintWriter out

Constructor Detail

WriterReportImpl

public WriterReportImpl(java.io.PrintWriter out)

WriterReportImpl

public WriterReportImpl(java.io.PrintWriter out,
                        java.lang.String info)

WriterReportImpl

public WriterReportImpl(java.io.PrintWriter out,
                        java.lang.String info,
                        boolean quiet)

Method Detail

fixMessage

java.lang.String fixMessage(java.lang.String message)

message

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

Description copied from interface: Report

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.

error

void error(java.lang.String resource,
           int line,
           int column,
           java.lang.String message)

fatalError

void fatalError(java.lang.String resource,
                int line,
                int column,
                java.lang.String message)

warning

void warning(java.lang.String resource,
             int line,
             int column,
             java.lang.String message)

info

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

Description copied from interface: Report

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

initialize

public void initialize()

Description copied from interface: Report

Called when a report if first created

hint

public void hint(java.lang.String resource,
                 int line,
                 int column,
                 java.lang.String message)

generate

public int generate()

Description copied from interface: Report

Called to create a report after the checks have been made