org.gradle.api.tasks.diagnostics
Class TextProjectReportRenderer

java.lang.Object
  org.gradle.api.tasks.diagnostics.TextProjectReportRenderer

All Implemented Interfaces:

ProjectReportRenderer

Direct Known Subclasses:

AsciiReportRenderer, GraphvizReportRenderer, PropertyReportRenderer, TaskReportRenderer

public class TextProjectReportRenderer
extends Object
implements ProjectReportRenderer

A basic ProjectReportRenderer which writes out a text report.

Field Summary

static String

SEPARATOR

Constructor Summary

TextProjectReportRenderer()

TextProjectReportRenderer(Appendable writer)

Method Summary

void	complete() Completes this report.
void	completeProject(Project project) Completes visiting a project.
protected Formatter	getFormatter()
protected Appendable	getWriter()
void	setOutputFile(File file) Sets the output file for the report.
void	startProject(Project project) Starts visiting a project.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

Constructor Detail

TextProjectReportRenderer

public TextProjectReportRenderer()

TextProjectReportRenderer

public TextProjectReportRenderer(Appendable writer)

Method Detail

setOutputFile

public void setOutputFile(File file)
                   throws IOException

Description copied from interface: ProjectReportRenderer

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

Specified by:

setOutputFile in interface ProjectReportRenderer

Parameters:

file - The output file, never null.

Throws:

IOException

startProject

public void startProject(Project project)

Description copied from interface: ProjectReportRenderer

Starts visiting a project.

Specified by:

startProject in interface ProjectReportRenderer

Parameters:

project - The project, never null.

completeProject

public void completeProject(Project project)

Description copied from interface: ProjectReportRenderer

Completes visiting a project.

Specified by:

completeProject in interface ProjectReportRenderer

Parameters:

project - The project, never null.

complete

public void complete()
              throws IOException

Description copied from interface: ProjectReportRenderer

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

Specified by:

complete in interface ProjectReportRenderer

Throws:

IOException

getWriter

protected Appendable getWriter()

getFormatter

protected Formatter getFormatter()