Class XDocsBugReporter

    • Field Detail

      • project

        private final Project project
      • document

        private final org.dom4j.Document document
      • root

        private final org.dom4j.Element root
      • ROOT_ELEMENT_NAME

        private static final java.lang.String ROOT_ELEMENT_NAME
        See Also:
        Constant Field Values
      • PROJECT_ELEMENT_NAME

        private static final java.lang.String PROJECT_ELEMENT_NAME
        See Also:
        Constant Field Values
      • ERRORS_ELEMENT_NAME

        private static final java.lang.String ERRORS_ELEMENT_NAME
        See Also:
        Constant Field Values
      • ANALYSIS_ERROR_ELEMENT_NAME

        private static final java.lang.String ANALYSIS_ERROR_ELEMENT_NAME
        See Also:
        Constant Field Values
      • MISSING_CLASS_ELEMENT_NAME

        private static final java.lang.String MISSING_CLASS_ELEMENT_NAME
        See Also:
        Constant Field Values
      • SUMMARY_HTML_ELEMENT_NAME

        private static final java.lang.String SUMMARY_HTML_ELEMENT_NAME
        See Also:
        Constant Field Values
      • FILE_ELEMENT_NAME

        private static final java.lang.String FILE_ELEMENT_NAME
        See Also:
        Constant Field Values
    • Constructor Detail

      • XDocsBugReporter

        public XDocsBugReporter​(Project project)
    • Method Detail

      • observeClass

        public void observeClass​(ClassDescriptor classDescriptor)
        Description copied from interface: IClassObserver
        Observe a class being visited.
        Parameters:
        classDescriptor - class being visited
      • logError

        public void logError​(java.lang.String message)
        Description copied from interface: IErrorLogger
        Log an error that occurs while performing analysis.
        Specified by:
        logError in interface IErrorLogger
        Overrides:
        logError in class AbstractBugReporter
        Parameters:
        message - the error message
      • doReportBug

        public void doReportBug​(BugInstance bugInstance)
        Description copied from class: AbstractBugReporter
        Subclasses must override this. It will be called only for bugs which meet the priority threshold.
        Specified by:
        doReportBug in class AbstractBugReporter
        Parameters:
        bugInstance - the bug to report
      • finish

        public void finish()
        Description copied from interface: BugReporter
        Finish reporting bugs. If any bug reports have been queued, calling this method will flush them.
      • writeXML

        private void writeXML​(java.io.Writer out,
                              Project project)
                       throws java.io.IOException
        Throws:
        java.io.IOException
      • endDocument

        private org.dom4j.Document endDocument​(Project project)
      • xmlEscape

        private static java.lang.String xmlEscape​(java.lang.String theString)
      • toElement

        public void toElement​(BugInstance bugInstance)
      • getBugCollection

        @Nonnull
        public BugCollection getBugCollection()
        Description copied from interface: BugReporter
        Get the bug collection (if any) associated with this bug reporter