org.gradle.api.tasks.diagnostics.internal

Class TextReportRenderer

java.lang.Object

org.gradle.api.tasks.diagnostics.internal.TextReportRenderer

All Implemented Interfaces:

ReportRenderer

Direct Known Subclasses:

AsciiReportRenderer, GraphvizReportRenderer, PropertyReportRenderer, TaskReportRenderer

public class TextReportRenderer
extends java.lang.Object
implements ReportRenderer

A basic ReportRenderer which writes out a text report.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
TextReportRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
void	complete() Completes this report.
void	completeProject(Project project) Completes visiting a project.
protected java.lang.String	createHeader(Project project)
StyledTextOutput	getTextOutput()
void	setOutput(StyledTextOutput textOutput) Sets the text output for the report.
void	setOutputFile(java.io.File file) Sets the output file for the report.
void	startProject(Project project) Starts visiting a project.
void	writeHeading(java.lang.String heading)
void	writeSubheading(java.lang.String heading)

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR

See Also:

Constant Field Values

Constructor Detail

TextReportRenderer

public TextReportRenderer()

Method Detail

setOutput

public void setOutput(StyledTextOutput textOutput)

Description copied from interface: ReportRenderer

Sets the text output for the report. This method must be called before any other methods on this renderer.

Specified by:

setOutput in interface ReportRenderer

Parameters:

textOutput - The text output, never null.

setOutputFile

public void setOutputFile(java.io.File file)
                   throws java.io.IOException

Description copied from interface: ReportRenderer

Sets the output file for the report. This method must be called before any other methods on this renderer.

Specified by:

setOutputFile in interface ReportRenderer

Parameters:

file - The output file, never null.

Throws:

java.io.IOException

startProject

public void startProject(Project project)

Description copied from interface: ReportRenderer

Starts visiting a project.

Specified by:

startProject in interface ReportRenderer

Parameters:

project - The project, never null.

createHeader

protected java.lang.String createHeader(Project project)

completeProject

public void completeProject(Project project)

Description copied from interface: ReportRenderer

Completes visiting a project.

Specified by:

completeProject in interface ReportRenderer

Parameters:

project - The project, never null.

complete

public void complete()
              throws java.io.IOException

Description copied from interface: ReportRenderer

Completes this report. This method must be called last on this renderer.

Specified by:

complete in interface ReportRenderer

Throws:

java.io.IOException

getTextOutput

public StyledTextOutput getTextOutput()

writeHeading

public void writeHeading(java.lang.String heading)

writeSubheading

public void writeSubheading(java.lang.String heading)