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 Details

    • message

      void message(MessageId id, EPUBLocation location, 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, 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(String resource, FeatureEnum feature, 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(String value)

    • getEpubFileName

      String getEpubFileName()

    • setCustomMessageFile

      void setCustomMessageFile(String customMessageFileName)

    • getCustomMessageFile

      String getCustomMessageFile()

    • getReportingLevel

      int getReportingLevel()

    • setReportingLevel

      void setReportingLevel(int level)

    • close

      void close()

    • setOverrideFile

      void setOverrideFile(File customMessageFile)

    • getDictionary

      MessageDictionary getDictionary()