org.gradle.api.reporting.internal

Class SimpleReport

java.lang.Object

org.gradle.api.reporting.internal.SimpleReport

All Implemented Interfaces:

Serializable, Report, Configurable<Report>

Direct Known Subclasses:

TaskGeneratedReport

public class SimpleReport
extends Object
implements Report

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.reporting.Report

Report.OutputType

Field Summary

Fields inherited from interface org.gradle.api.reporting.Report

NAMER

Constructor Summary

Constructors

Constructor and Description
SimpleReport(String name, Report.OutputType outputType, FileResolver fileResolver)

Method Summary

Methods

Modifier and Type	Method and Description
Report	configure(Closure configure)
File	getDestination() The location on the filesystem of the report when it is generated.
String	getName() The symbolic name of this report.
Report.OutputType	getOutputType() The type of output that the report generates.
boolean	isEnabled() Whether or not this report should be generated by whatever generates it.
protected void	setDestination(Object destination)
void	setEnabled(boolean enabled) Whether or not this report should be generated by whatever generates it.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleReport

public SimpleReport(String name,
            Report.OutputType outputType,
            FileResolver fileResolver)

Method Detail

getName

public String getName()

Description copied from interface: Report

The symbolic name of this report. The name of the report usually indicates the format (e.g. xml, html etc.) but can be anything. When part of a ReportContainer, reports are accessed via their name. That is, given a report container variable named reports containing a report who's getName() returns "html", the report could be accessed via:

 reports.html
 

Specified by:

getName in interface Report

Returns:

The name of this report.

toString

public String toString()

Overrides:

toString in class Object

getDestination

public File getDestination()

Description copied from interface: Report

The location on the filesystem of the report when it is generated. Depending on the output type of the report, this may point to a file or a directory. Subtypes may implement setters for the destination.

Specified by:

getDestination in interface Report

Returns:

The location on the filesystem of the report when it is generated

setDestination

protected void setDestination(Object destination)

getOutputType

public Report.OutputType getOutputType()

Description copied from interface: Report

The type of output that the report generates.

Specified by:

getOutputType in interface Report

Returns:

The type of output that the report generates.

configure

public Report configure(Closure configure)

Specified by:

configure in interface Configurable<Report>

isEnabled

public boolean isEnabled()

Description copied from interface: Report

Whether or not this report should be generated by whatever generates it. If true, the generator of this report will generate it at the appropriate time. If false, the generator of this report will not generate this report.

Specified by:

isEnabled in interface Report

Returns:

Whether or not this report should be generated by whatever generates it.

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: Report

Whether or not this report should be generated by whatever generates it.

Specified by:

setEnabled in interface Report

Parameters:

enabled - Whether or not this report should be generated by whatever generates it.

See Also:

Report.isEnabled()