de.smartics.maven.exceptions.sdoccode.report
Class SdocCodeReportGenerator

java.lang.Object
  de.smartics.report.generator.AbstractReportGenerator<File>
      de.smartics.maven.exceptions.sdoccode.report.SdocCodeReportGenerator

All Implemented Interfaces:

de.smartics.report.conf.ReportGenerator< File>

public class SdocCodeReportGenerator
     
     

      
      extends de.smartics.report.generator.AbstractReportGenerator<
      
      File>
     
     

Writes individual reports in the projectdoc's code doctype.

Author:

Robert Reiner

Field Summary

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

encoding, output, renderer

Fields inherited from interface de.smartics.report.conf.ReportGenerator

DEFAULT_ENCODING

Constructor Summary

SdocCodeReportGenerator()
Default constructor.

Method Summary

protected void	writeContent(File output, de.smartics.report.conf.ProjectConfiguration<File> config, de.smartics.report.conf.ReportData reportData)
protected void	writeReportElementInfo(OutputStream reportOut, de.smartics.report.conf.ProjectConfiguration<File> config, CodeUtils.CodeContainer codeContainer)

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

getEncoding, getOutput, setEncoding, setOutput, writeReport

Methods inherited from class java.lang.Object

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

Constructor Detail

SdocCodeReportGenerator

public SdocCodeReportGenerator()
                        throws ParserConfigurationException

Default constructor.

Parameters:

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

Throws:

ParserConfigurationException - if creating XML infrstructure fails.

Method Detail

writeContent

protected void writeContent(File output,
                            de.smartics.report.conf.ProjectConfiguration<File> config,
                            de.smartics.report.conf.ReportData reportData)
                     throws Exception

Specified by:

writeContent in class de.smartics.report.generator.AbstractReportGenerator<File>

Parameters:

output - the directory to write the individual reports to.

Throws:

Exception

See Also:

AbstractReportGenerator.writeContent(java.lang.Object, de.smartics.report.conf.ProjectConfiguration, de.smartics.report.conf.ReportData)

writeReportElementInfo

protected void writeReportElementInfo(OutputStream reportOut,
                                      de.smartics.report.conf.ProjectConfiguration<File> config,
                                      CodeUtils.CodeContainer codeContainer)
                               throws Exception

Throws:

Exception