de.smartics.testdoc.maven.export
Class AbstractOutputManager

java.lang.Object
  de.smartics.testdoc.maven.export.AbstractOutputManager

All Implemented Interfaces:

de.smartics.testdoc.core.doc.OutputManager

Direct Known Subclasses:

SinkOutputManager, XmlOutputManager

public abstract class AbstractOutputManager
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements de.smartics.testdoc.core.doc.OutputManager
     
     

Export UnitTestDoc information to an output medium. The output to this medium is defined by a subclass. This class essentially holds the information and meta data to be exported.

Author:

Robert Reiner

Field Summary

protected de.smartics.testdoc.core.export.UnitTestDocExporter	exporter The exporter that knows the format of the file to be written.
protected ExportMultiIndex	index The multi index to create the sections of the output document.
protected de.smartics.maven.util.report.MessageHelper	messages The resource bundles with messages to display as labels in the generated report.
protected String	reportName The name of the report to export.
protected Set<de.smartics.testdoc.core.doc.UnitTestDoc>	testDocs The cached test documentation instances.

Constructor Summary

protected

AbstractOutputManager(String reportName, de.smartics.maven.util.report.MessageHelper messages, AbstractReportExporter exporter, List<ExportIndex> exportIndices) Default constructor.

Method Summary

void	export(de.smartics.testdoc.core.doc.UnitTestDoc testDoc)
void	init()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.smartics.testdoc.core.doc.OutputManager

finish

Field Detail

reportName

protected final String reportName

The name of the report to export.

messages

protected final de.smartics.maven.util.report.MessageHelper messages

The resource bundles with messages to display as labels in the generated report.

exporter

protected final de.smartics.testdoc.core.export.UnitTestDocExporter exporter

The exporter that knows the format of the file to be written.

index

protected final ExportMultiIndex index

The multi index to create the sections of the output document.

testDocs

protected final Set<de.smartics.testdoc.core.doc.UnitTestDoc> testDocs

The cached test documentation instances.

Constructor Detail

AbstractOutputManager

protected AbstractOutputManager(String reportName,
                                de.smartics.maven.util.report.MessageHelper messages,
                                AbstractReportExporter exporter,
                                List<ExportIndex> exportIndices)

Default constructor.

Parameters:

reportName - the name of the report to export.

messages - the resource bundles with messages to display as labels in the generated report.

exporter - the exporter that knows the format of the file to be written.

exportIndices - the indices to created.

Method Detail

init

public void init()

Specified by:

init in interface de.smartics.testdoc.core.doc.OutputManager

See Also:

de.smartics.testdoc.report.doc.OutputManager#init()

export

public void export(de.smartics.testdoc.core.doc.UnitTestDoc testDoc)
            throws IOException

Specified by:

export in interface de.smartics.testdoc.core.doc.OutputManager

Throws:

IOException

See Also:

de.smartics.testdoc.report.doc.OutputManager#export(de.smartics.testdoc.report.doc.UnitTestDoc)