Package org.myire.scent.report

Class OutputStreamReportWriter

java.lang.Object

org.myire.scent.report.OutputStreamReportWriter

All Implemented Interfaces:

MetricsReportWriter

Direct Known Subclasses:

TextReportWriter, XmlReportWriter

public abstract class OutputStreamReportWriter
extends java.lang.Object
implements MetricsReportWriter

Abstract base class for writing metrics reports to an OutputStream.

Note that the protected write* methods throw an UncheckedIOException rather than an IOException. This is to allow these methods to be called in methods intended to implement functional interfaces that don't throw IOException. The main entry point for this class, writeReport(JavaMetrics, MetricsReportMetaData), catches any thrown UncheckedIOException and throws its IOException cause.

Author:

Peter Franzen

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OutputStreamReportWriter(java.io.OutputStream pOutputStream, java.nio.charset.Charset pCharset)	Create a new OutputStreamReportWriter.

Method Summary

Modifier and Type	Method	Description
protected void	decreaseIndentationLevel()	Decrease the indentation level used by writeIndentation().
protected void	flush()	Flush any buffered writes to the underlying stream.
protected void	increaseIndentationLevel()	Increase the indentation level used by writeIndentation().
protected void	write(char pChar)	Write a single character to the underlying stream.
protected void	write(char[] pChars)	Write all characters in an array to the underlying stream.
protected void	write(java.lang.String pChars)	Write all characters in a string to the underlying stream.
protected void	writeIndentation()	Write the current indentation to the underlying stream.
protected void	writeLineBreak()	Write the platform's line separator to the underlying stream.
void	writeReport(JavaMetrics pMetrics, MetricsReportMetaData pMetaData)	Write a report for the source code metrics in a JavaMetrics instance.
protected abstract 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

Constructor Detail

OutputStreamReportWriter

protected OutputStreamReportWriter(@Nonnull
                                   java.io.OutputStream pOutputStream,
                                   @Nonnull
                                   java.nio.charset.Charset pCharset)

Create a new OutputStreamReportWriter.

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

writeReport

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

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

Specified by:

writeReport in interface MetricsReportWriter

Parameters:

pMetrics - The metrics to get the report data from.

pMetaData - The report's meta data.

Throws:

java.io.IOException - if writing to the underlying stream fails.

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

writeReportContents

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

Write the report's contents to the underlying stream.

Parameters:

pMetrics - The metrics to get the report data from.

pMetaData - The report's meta data.

Throws:

java.io.UncheckedIOException - if writing to the underlying stream fails.

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

increaseIndentationLevel

protected void increaseIndentationLevel()

Increase the indentation level used by writeIndentation().

decreaseIndentationLevel

protected void decreaseIndentationLevel()

Decrease the indentation level used by writeIndentation().

writeIndentation

protected void writeIndentation()

Write the current indentation to the underlying stream. Each indentation level is represented by two spaces.

Throws:

java.io.UncheckedIOException - if writing to the underlying stream fails.

writeLineBreak

protected void writeLineBreak()

Write the platform's line separator to the underlying stream.

Throws:

java.io.UncheckedIOException - if writing to the underlying stream fails.

write

protected void write(char pChar)

Write a single character to the underlying stream.

Parameters:

pChar - The character to write.

Throws:

java.io.UncheckedIOException - if writing to the underlying stream fails.

write

protected void write(@Nonnull
                     char[] pChars)

Write all characters in an array to the underlying stream.

Parameters:

pChars - The characters to write.

Throws:

java.io.UncheckedIOException - if writing to the underlying stream fails.

java.lang.NullPointerException - if pChars is null.

write

protected void write(@Nonnull
                     java.lang.String pChars)

Write all characters in a string to the underlying stream.

Parameters:

pChars - The characters to write.

Throws:

java.io.UncheckedIOException - if writing to the underlying stream fails.

java.lang.NullPointerException - if pChars is null.

flush

protected void flush()

Flush any buffered writes to the underlying stream.

Throws:

java.io.UncheckedIOException - if flushing to the underlying stream fails.