Package org.myire.scent.report

Interface MetricsReportWriter

All Known Implementing Classes:

OutputStreamReportWriter, TextReportWriter, XmlReportWriter, XslReportWriter

public interface MetricsReportWriter

A MetricsReportWriter writes the source code metrics in a JavaMetrics instance to a destination of some sort and on a format of some kind.

Author:

Peter Franzen

Method Summary

Modifier and Type	Method	Description
void	writeReport(JavaMetrics pMetrics, MetricsReportMetaData pMetaData)	Write a report for the source code metrics in a JavaMetrics instance.

Method Detail

writeReport

void writeReport(@Nonnull
                 JavaMetrics pMetrics,
                 @Nonnull
                 MetricsReportMetaData pMetaData)
          throws java.io.IOException

Write a report for the source code metrics in a JavaMetrics instance.

Parameters:

pMetrics - The metrics to get the report data from.

pMetaData - The report's meta data.

Throws:

java.io.IOException - if writing the report fails.

java.lang.NullPointerException - if any of the parameters is null.