de.smartics.maven.exceptions
Class AbstractSinkReportGenerator

java.lang.Object
  de.smartics.report.generator.AbstractReportGenerator<O>
      de.smartics.report.generator.AbstractOutputReportGenerator
          de.smartics.maven.exceptions.AbstractSinkReportGenerator

All Implemented Interfaces:

de.smartics.report.conf.ReportGenerator

Direct Known Subclasses:

CodeSortedSinkReportGenerator, PackageSortedSinkReportGenerator

public abstract class AbstractSinkReportGenerator
     
     

      
      extends de.smartics.report.generator.AbstractOutputReportGenerator
     
     

Simple generator that generates with a Maven sink.

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

protected

AbstractSinkReportGenerator() Default constructor.

Method Summary

protected org.apache.maven.doxia.sink.Sink	toSink(Object sink) Makes the cast.
protected void	writeContent(Object output, de.smartics.report.conf.ProjectConfiguration config, de.smartics.report.conf.ReportData reportData)
protected void	writeFooter(Object output, de.smartics.report.conf.ProjectConfiguration config)
protected void	writeInfoFooter(Object output, de.smartics.report.conf.ProjectConfiguration config)
protected void	writeInfoHeader(Object output, de.smartics.report.conf.ProjectConfiguration config, String headLine, com.sun.javadoc.ClassDoc classDoc) Writes the header and introduction text on a section 2.
protected void	writeInfoSubFooter(Object output, de.smartics.report.conf.ProjectConfiguration config)
protected void	writeInfoSubHeader(Object output, de.smartics.report.conf.ProjectConfiguration config, String subHeader)
protected void	writeReportElementInfo(Object output, de.smartics.report.conf.ProjectConfiguration config, com.sun.javadoc.FieldDoc fieldDoc)
protected void	writeTableHeader(Object output, de.smartics.report.conf.ProjectConfiguration config) Writes the table header.

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

write, writeHeader

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

AbstractSinkReportGenerator

protected AbstractSinkReportGenerator()

Default constructor.

Method Detail

toSink

protected org.apache.maven.doxia.sink.Sink toSink(Object sink)

Makes the cast.

Parameters:

sink - the instance to cast.

Returns:

the sink with the concrete type.

writeReportElementInfo

protected void writeReportElementInfo(Object output,
                                      de.smartics.report.conf.ProjectConfiguration config,
                                      com.sun.javadoc.FieldDoc fieldDoc)
                               throws Exception

Specified by:

writeReportElementInfo in class de.smartics.report.generator.AbstractOutputReportGenerator

Throws:

Exception

writeContent

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

Specified by:

writeContent in class de.smartics.report.generator.AbstractReportGenerator

Throws:

Exception

writeInfoFooter

protected void writeInfoFooter(Object output,
                               de.smartics.report.conf.ProjectConfiguration config)
                        throws Exception

Specified by:

writeInfoFooter in class de.smartics.report.generator.AbstractOutputReportGenerator

Throws:

Exception

writeInfoSubFooter

protected void writeInfoSubFooter(Object output,
                                  de.smartics.report.conf.ProjectConfiguration config)
                           throws Exception

Throws:

Exception

writeInfoHeader

protected void writeInfoHeader(Object output,
                               de.smartics.report.conf.ProjectConfiguration config,
                               String headLine,
                               com.sun.javadoc.ClassDoc classDoc)
                        throws Exception

Writes the header and introduction text on a section 2.

If no headLine is given, the qualified class name is written as section title instead.

Specified by:

writeInfoHeader in class de.smartics.report.generator.AbstractOutputReportGenerator

Parameters:

output - the output to write to.

config - not used in this implementation.

headLine - the text for the section header. May be null.

classDoc - the type information to render if headLine is null as section header and its comment to render as introduction text.

Throws:

Exception - on any problem encountered.

writeInfoSubHeader

protected void writeInfoSubHeader(Object output,
                                  de.smartics.report.conf.ProjectConfiguration config,
                                  String subHeader)

Overrides:

writeInfoSubHeader in class de.smartics.report.generator.AbstractOutputReportGenerator

writeTableHeader

protected void writeTableHeader(Object output,
                                de.smartics.report.conf.ProjectConfiguration config)

Writes the table header.

Specified by:

writeTableHeader in class de.smartics.report.generator.AbstractOutputReportGenerator

Parameters:

output - the output to write to.

config - the project configuration to control the output.

writeFooter

protected void writeFooter(Object output,
                           de.smartics.report.conf.ProjectConfiguration config)

Overrides:

writeFooter in class de.smartics.report.generator.AbstractOutputReportGenerator