org.myire.quill.report

Class SimpleConfigurableReport

java.lang.Object

org.myire.quill.common.ProjectAware

org.myire.quill.report.SimpleConfigurableReport

All Implemented Interfaces:

org.gradle.api.reporting.ConfigurableReport, org.gradle.api.reporting.Report, org.gradle.util.Configurable<org.gradle.api.reporting.Report>

Direct Known Subclasses:

DefaultDestinationReport

public abstract class SimpleConfigurableReport
extends ProjectAware
implements org.gradle.api.reporting.ConfigurableReport

Implementation of org.gradle.api.reporting.ConfigurableReport.

Nested Class Summary

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

org.gradle.api.reporting.Report.OutputType

Field Summary

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

NAMER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleConfigurableReport(org.gradle.api.Project pProject, java.lang.String pName, java.lang.String pDisplayName, org.gradle.api.reporting.Report.OutputType pOutputType) Create a new SimpleReport.

Method Summary

Modifier and Type	Method and Description
org.gradle.api.reporting.Report	configure(groovy.lang.Closure pConfigureClosure)
java.io.File	getDestination()
java.lang.String	getDisplayName()
java.lang.String	getName()
org.gradle.api.reporting.Report.OutputType	getOutputType()
org.gradle.api.Project	getProject() Get this entity's associated project.
org.gradle.api.logging.Logger	getProjectLogger() Get the project's Logger instance.
org.gradle.api.provider.Property<java.lang.Boolean>	getRequired()
boolean	isEnabled()
protected boolean	reportIsRequired() Check if this report is required (enabled) and should be created.
protected java.io.File	resolveDestination() Resolve the destination specified by the latest call to setDestination(File), setDestination(Provider), or useDestination(Object).
void	setDestination(java.io.File pFile)
void	setDestination(org.gradle.api.provider.Provider<java.io.File> pProvider)
void	setEnabled(boolean pEnabled)
void	setEnabled(org.gradle.api.provider.Provider<java.lang.Boolean> pProvider)
void	setOutputLocation(java.lang.Object pLocation) Set the value of the outputLocation property.
void	setRequired(boolean pValue) Set the value of the required property.
java.lang.String	toString()
protected void	useDestination(java.lang.Object pDestination) Set the value of the report's destination without calling setDestination(File).

Methods inherited from class java.lang.Object

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

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

getOutputLocation

Constructor Detail

SimpleConfigurableReport

protected SimpleConfigurableReport(org.gradle.api.Project pProject,
                                   java.lang.String pName,
                                   java.lang.String pDisplayName,
                                   org.gradle.api.reporting.Report.OutputType pOutputType)

Create a new SimpleReport.

Parameters:

pProject - The project for which the report will be produced.

pName - The report's symbolic name.

pDisplayName - The report's descriptive name.

pOutputType - The type of output the report produces.

Throws:

java.lang.NullPointerException - if pProject is null.

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface org.gradle.api.reporting.Report

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface org.gradle.api.reporting.Report

getOutputType

public org.gradle.api.reporting.Report.OutputType getOutputType()

Specified by:

getOutputType in interface org.gradle.api.reporting.Report

getDestination

public java.io.File getDestination()

Specified by:

getDestination in interface org.gradle.api.reporting.Report

setDestination

public void setDestination(java.io.File pFile)

Specified by:

setDestination in interface org.gradle.api.reporting.ConfigurableReport

setDestination

public void setDestination(org.gradle.api.provider.Provider<java.io.File> pProvider)

Specified by:

setDestination in interface org.gradle.api.reporting.ConfigurableReport

setOutputLocation

public void setOutputLocation(java.lang.Object pLocation)

Set the value of the outputLocation property.

Parameters:

pLocation - The property's new value.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface org.gradle.api.reporting.Report

setEnabled

public void setEnabled(boolean pEnabled)

Specified by:

setEnabled in interface org.gradle.api.reporting.ConfigurableReport

Specified by:

setEnabled in interface org.gradle.api.reporting.Report

setEnabled

public void setEnabled(org.gradle.api.provider.Provider<java.lang.Boolean> pProvider)

Specified by:

setEnabled in interface org.gradle.api.reporting.ConfigurableReport

configure

public org.gradle.api.reporting.Report configure(groovy.lang.Closure pConfigureClosure)

Specified by:

configure in interface org.gradle.util.Configurable<org.gradle.api.reporting.Report>

getRequired

@Input
public org.gradle.api.provider.Property<java.lang.Boolean> getRequired()

Specified by:

getRequired in interface org.gradle.api.reporting.Report

setRequired

public void setRequired(boolean pValue)

Set the value of the required property.

Parameters:

pValue - The property's new value.

getProject

@Internal
public org.gradle.api.Project getProject()

Description copied from class: ProjectAware

Get this entity's associated project.

Overrides:

getProject in class ProjectAware

Returns:

The project, never null.

getProjectLogger

@Internal
public org.gradle.api.logging.Logger getProjectLogger()

Description copied from class: ProjectAware

Get the project's Logger instance.

Overrides:

getProjectLogger in class ProjectAware

Returns:

The project's Logger instance.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

reportIsRequired

protected boolean reportIsRequired()

Check if this report is required (enabled) and should be created.

Returns:

True if this report is required, false if not.

resolveDestination

protected java.io.File resolveDestination()

Resolve the destination specified by the latest call to setDestination(File), setDestination(Provider), or useDestination(Object).

Returns:

The destination file resolved with the project directory as base directory. If no destination has been specified, null is returned.

useDestination

protected void useDestination(java.lang.Object pDestination)

Set the value of the report's destination without calling setDestination(File). That method was deprecated in Gradle 7.1.

Parameters:

pDestination - The report's destination, possibly null.