com.manoelcampos.javadoc.coverage.exporter

Interface DataExporter

All Known Implementing Classes:

AbstractDataExporter, ConsoleExporter, HtmlExporter

public interface DataExporter

An interface to implement JavaDoc Coverage reports in different formats such as HTML, CSV, JSON, etc.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_OUTPUT_NAME The name to be used as default for the JavaDoc Coverage report if a specific name is not given.

Method Summary

Modifier and Type	Method and Description
boolean	build() Builds the JavaDoc Coverage Report to the file specified by getReportFileName().
String	getReportFileName() Gets the actual name to be used for the JavaDoc Coverage Report, whether the default or given one.

Field Detail

DEFAULT_OUTPUT_NAME

static final String DEFAULT_OUTPUT_NAME

The name to be used as default for the JavaDoc Coverage report if a specific name is not given.

See Also:

CoverageDoclet.OUTPUT_NAME_OPTION, Constant Field Values

Method Detail

getReportFileName

String getReportFileName()

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

Returns:

See Also:

DEFAULT_OUTPUT_NAME

build

boolean build()

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

Returns: