org.gradle.api.tasks.diagnostics.internal

Interface ReportRenderer

All Known Subinterfaces:

DependencyReportRenderer

All Known Implementing Classes:

AsciiReportRenderer, GraphvizReportRenderer, PropertyReportRenderer, TaskReportRenderer, TextReportRenderer

public interface ReportRenderer

A ProjectReportRenderer is responsible for rendering the model of a project report.

Method Summary

Methods

Modifier and Type	Method and Description
void	complete() Completes this report.
void	completeProject(Project project) Completes visiting a project.
void	setOutput(StyledTextOutput textOutput) Sets the text output for the report.
void	setOutputFile(File file) Sets the output file for the report.
void	startProject(Project project) Starts visiting a project.

Method Detail

setOutput

void setOutput(StyledTextOutput textOutput)

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

Parameters:

textOutput - The text output, never null.

setOutputFile

void setOutputFile(File file)
                   throws IOException

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

Parameters:

file - The output file, never null.

Throws:

IOException

startProject

void startProject(Project project)

Starts visiting a project.

Parameters:

project - The project, never null.

completeProject

void completeProject(Project project)

Completes visiting a project.

Parameters:

project - The project, never null.

complete

void complete()
              throws IOException

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

Throws:

IOException