Package org.myire.scent.report

Class TextReportWriter

java.lang.Object

org.myire.scent.report.OutputStreamReportWriter

org.myire.scent.report.TextReportWriter

All Implemented Interfaces:

MetricsReportWriter

public class TextReportWriter
extends OutputStreamReportWriter

A writer of metrics reports on plain text format to an OutputStream.

Author:

Peter Franzen

Constructor Summary

Constructors

Constructor	Description
TextReportWriter(java.io.OutputStream pOutputStream)	Create a new TextReportWriter that uses UTF-8 as encoding.
TextReportWriter(java.io.OutputStream pOutputStream, java.nio.charset.Charset pCharset)	Create a new TextReportWriter.

Method Summary

Modifier and Type	Method	Description
protected void	writeReportContents(JavaMetrics pMetrics, MetricsReportMetaData pMetaData)	Write the report's contents to the underlying stream.

Methods inherited from class java.lang.Object

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

Methods inherited from class org.myire.scent.report.OutputStreamReportWriter

decreaseIndentationLevel, flush, increaseIndentationLevel, write, write, write, writeIndentation, writeLineBreak, writeReport

Constructor Detail

TextReportWriter

public TextReportWriter(@Nonnull
                        java.io.OutputStream pOutputStream)

Create a new TextReportWriter that uses UTF-8 as encoding.

Parameters:

pOutputStream - The stream to write the report to.

Throws:

java.lang.NullPointerException - if pOutputStream is null.

TextReportWriter

public TextReportWriter(@Nonnull
                        java.io.OutputStream pOutputStream,
                        @Nonnull
                        java.nio.charset.Charset pCharset)

Create a new TextReportWriter.

Parameters:

pOutputStream - The stream to write the report to.

pCharset - The character set to encode the report with.

Throws:

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

Method Detail

writeReportContents

protected void writeReportContents(@Nonnull
                                   JavaMetrics pMetrics,
                                   @Nonnull
                                   MetricsReportMetaData pMetaData)

Description copied from class: OutputStreamReportWriter

Write the report's contents to the underlying stream.

Specified by:

writeReportContents in class OutputStreamReportWriter

Parameters:

pMetrics - The metrics to get the report data from.

pMetaData - The report's meta data.