org.myire.quill.report

Class ReportWriter

java.lang.Object

org.myire.quill.report.ReportWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

XmlReportWriter

public class ReportWriter
extends java.lang.Object
implements java.io.Closeable

A writer for the destination file of a SingleFileReport.

Constructor Summary

Constructors

Constructor and Description
ReportWriter(org.gradle.api.reporting.SingleFileReport pReport, java.nio.charset.Charset pCharset, java.nio.file.OpenOption... pOpenOptions) Create a new ReportWriter.

Method Summary

Modifier and Type	Method and Description
void	close()
void	decreaseIndentationLevel() Decrease the indentation level used by writeIndentation().
void	flush() Flush any buffered writes to the report file.
void	increaseIndentationLevel() Increase the indentation level used by writeIndentation().
void	write(char pChar) Write a single character to the report file.
void	write(char[] pChars) Write all characters in an array to the report file.
void	write(java.lang.String pChars) Write all characters in a string to the report file.
void	writeIndentation() Write the current indentation to the report file.
void	writeLineBreak() Write the platform's line separator to the report file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportWriter

public ReportWriter(org.gradle.api.reporting.SingleFileReport pReport,
                    java.nio.charset.Charset pCharset,
                    java.nio.file.OpenOption... pOpenOptions)
             throws java.io.IOException

Create a new ReportWriter.

Parameters:

pReport - The report to write.

pCharset - The character set to encode the report with.

pOpenOptions - Any options to specify when opening the report's file.

Throws:

java.io.IOException - if opening the report's destination file fails.

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

Method Detail

increaseIndentationLevel

public void increaseIndentationLevel()

Increase the indentation level used by writeIndentation().

decreaseIndentationLevel

public void decreaseIndentationLevel()

Decrease the indentation level used by writeIndentation().

writeIndentation

public void writeIndentation()
                      throws java.io.IOException

Write the current indentation to the report file. Each indentation level is represented by two spaces.

Throws:

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

writeLineBreak

public void writeLineBreak()
                    throws java.io.IOException

Write the platform's line separator to the report file.

Throws:

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

write

public void write(char pChar)
           throws java.io.IOException

Write a single character to the report file.

Parameters:

pChar - The character to write.

Throws:

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

write

public void write(char[] pChars)
           throws java.io.IOException

Write all characters in an array to the report file.

Parameters:

pChars - The characters to write.

Throws:

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

java.lang.NullPointerException - if pChars is null.

write

public void write(java.lang.String pChars)
           throws java.io.IOException

Write all characters in a string to the report file.

Parameters:

pChars - The characters to write.

Throws:

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

java.lang.NullPointerException - if pChars is null.

flush

public void flush()
           throws java.io.IOException

Flush any buffered writes to the report file.

Throws:

java.io.IOException - if flushing to the report file fails.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException