de.smartics.exceptions.report.generator
Class AbstractXmlReportGenerator

java.lang.Object
  de.smartics.exceptions.report.generator.AbstractReportGenerator<O>
      de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<XMLStreamWriter>
          de.smartics.exceptions.report.generator.AbstractXmlReportGenerator

All Implemented Interfaces:

ReportGenerator< XMLStreamWriter>

Direct Known Subclasses:

AbstractHtmlReportGenerator

public abstract class AbstractXmlReportGenerator
     
     

      
      extends 
      
      AbstractOutputReportGenerator<
      
      XMLStreamWriter>
     
     

Simple generator that generates a HTML file.

Field Summary

Fields inherited from class de.smartics.exceptions.report.generator.AbstractReportGenerator

encoding, output, renderer

Fields inherited from interface de.smartics.exceptions.report.generator.ReportGenerator

DEFAULT_ENCODING

Constructor Summary

protected

AbstractXmlReportGenerator(JavadocRenderer renderer) Default constructor.

Method Summary

static XMLStreamWriter	createOutput(Writer writer) Creates an output instance from a writer to use subclasses of this report generator implementation.
void	writeReport(ProjectConfiguration<XMLStreamWriter> config, StoredExceptionCodesReport report) Writes the report with the given information.

Methods inherited from class de.smartics.exceptions.report.generator.AbstractOutputReportGenerator

getCodeTitle, getCurrentSelection, getItems, hasSectionChanged, write, writeFooter, writeHeader, writeInfoFooter, writeInfoHeader, writeInfoSubHeader, writeReportElementInfo, writeTableHeader

Methods inherited from class de.smartics.exceptions.report.generator.AbstractReportGenerator

getEncoding, getOutput, setEncoding, setOutput, writeContent

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlReportGenerator

protected AbstractXmlReportGenerator(JavadocRenderer renderer)

Default constructor.

Parameters:

renderer - the renderer used to map Javadoc comments to the report's output format.

Method Detail

createOutput

public static XMLStreamWriter createOutput(Writer writer)
                                    throws XMLStreamException

Creates an output instance from a writer to use subclasses of this report generator implementation.

Parameters:

writer - the basic writer to use for XML writing.

Returns:

the output instance to use.

Throws:

XMLStreamException - on any problem generating the XML writer.

writeReport

public void writeReport(ProjectConfiguration<XMLStreamWriter> config,
                        StoredExceptionCodesReport report)
                 throws ReportException

Writes the report with the given information.

Specified by:

writeReport in interface ReportGenerator<XMLStreamWriter>

Overrides:

writeReport in class AbstractReportGenerator<XMLStreamWriter>

Parameters:

config - the project configuration to control the report generation.

report - the information to write.

Throws:

ReportException - on any problem generating the report.