com.manoelcampos.javadoc.coverage.exporter

Class AbstractDataExporter

java.lang.Object

com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter

All Implemented Interfaces:

DataExporter

Direct Known Subclasses:

ConsoleExporter, HtmlExporter

public abstract class AbstractDataExporter
extends Object
implements DataExporter

Abstract class to implement JavaDoc Coverage reports in different formats. Each sub-class should implement a specific format such as HTML, CSV, JSON, etc.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Field Summary

Fields inherited from interface com.manoelcampos.javadoc.coverage.exporter.DataExporter

DEFAULT_OUTPUT_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDataExporter(CoverageDoclet doclet) Instantiates a DataExporter object that generates JavaDoc coverage report to the standard output.
protected	AbstractDataExporter(CoverageDoclet doclet, String fileExtension) Instantiates a DataExporter object to generate JavaDoc coverage report.

Method Summary

Modifier and Type	Method and Description
protected abstract void	afterBuild()
boolean	build() Builds the JavaDoc Coverage Report to the file specified by DataExporter.getReportFileName().
protected abstract void	exportClassesDocStats()
protected abstract void	exportPackagesDocStats()
protected abstract void	exportProjectDocumentationCoverageSummary()
protected abstract void	footer()
File	getFile()
String	getReportFileName() Gets the actual name to be used for the JavaDoc Coverage Report, whether the default or given one.
protected JavaDocsStats	getStats()
protected PrintWriter	getWriter()
protected abstract void	header()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDataExporter

protected AbstractDataExporter(CoverageDoclet doclet,
                               String fileExtension)

Instantiates a DataExporter object to generate JavaDoc coverage report.

Parameters:

doclet - the CoverageDoclet which computes teh JavaDoc coverage statistics.

fileExtension - the extension to the report file. If empty, the report will be printed to the standard output.

AbstractDataExporter

protected AbstractDataExporter(CoverageDoclet doclet)
                        throws FileNotFoundException

Instantiates a DataExporter object that generates JavaDoc coverage report to the standard output.

Parameters:

doclet - the CoverageDoclet which computes teh JavaDoc coverage statistics.

Throws:

FileNotFoundException

Method Detail

getReportFileName

public String getReportFileName()

Description copied from interface: DataExporter

Gets the actual name to be used for the JavaDoc Coverage Report, whether the default or given one.

Specified by:

getReportFileName in interface DataExporter

Returns:

See Also:

DataExporter.DEFAULT_OUTPUT_NAME

build

public boolean build()

Description copied from interface: DataExporter

Builds the JavaDoc Coverage Report to the file specified by DataExporter.getReportFileName().

Specified by:

build in interface DataExporter

Returns:

getWriter

protected PrintWriter getWriter()

getStats

protected JavaDocsStats getStats()

getFile

public File getFile()

exportProjectDocumentationCoverageSummary

protected abstract void exportProjectDocumentationCoverageSummary()

header

protected abstract void header()

footer

protected abstract void footer()

afterBuild

protected abstract void afterBuild()

exportPackagesDocStats

protected abstract void exportPackagesDocStats()

exportClassesDocStats

protected abstract void exportClassesDocStats()