Package org.gradle.api.tasks.diagnostics

Klasse ConventionReportTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.diagnostics.ConventionReportTask

Alle implementierten Schnittstellen:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, Configurable<Task>

Bekannte direkte Unterklassen:

AbstractProjectBasedReportTask, ProjectBasedReportTask, TaskReportTask

@DisableCachingByDefault(because="Abstract super-class, not to be instantiated directly")
public abstract class ConventionReportTask
extends org.gradle.api.internal.ConventionTask

The base class for all project based report tasks with custom task actions.

Seit:

6.9

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen org.gradle.api.Task

Task.Namer

Feldübersicht

Von Schnittstelle geerbte Felder org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	ConventionReportTask()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected org.gradle.initialization.BuildClientMetaData	getClientMetaData()
File	getOutputFile()	Returns the file which the report will be written to.
DirectoryProperty	getProjectReportDirectory()	Returns the project report directory.
Set<Project>	getProjects()	Returns the set of project to generate this report for.
protected abstract org.gradle.api.tasks.diagnostics.internal.ReportRenderer	getRenderer()
protected org.gradle.internal.logging.text.StyledTextOutputFactory	getTextOutputFactory()
void	setOutputFile(File outputFile)	Sets the file which the report will be written to.
void	setProjects(Set<Project> projects)	Specifies the set of projects to generate this report for.

Von Klasse geerbte Methoden org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Von Klasse geerbte Methoden org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Von Klasse geerbte Methoden org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Konstruktordetails

ConventionReportTask

protected ConventionReportTask()

Methodendetails

getProjectReportDirectory

@Internal
public DirectoryProperty getProjectReportDirectory()

Returns the project report directory.

The project-report plugin sets the default value for all tasks of this type to buildDir/project.

Note, that if the project-report plugin is not applied then this property is ignored.

Gibt zurück:

the directory to store project reports

Seit:

7.1

getRenderer

@Internal
protected abstract org.gradle.api.tasks.diagnostics.internal.ReportRenderer getRenderer()

getOutputFile

@Nullable
@Optional
@OutputFile
public File getOutputFile()

Returns the file which the report will be written to. When set to null, the report is written to System.out. Defaults to null.

Gibt zurück:

The output file. May be null.

setOutputFile

public void setOutputFile(@Nullable
 File outputFile)

Sets the file which the report will be written to. Set this to null to write the report to System.out.

Parameter:

outputFile - The output file. May be null.

getProjects

@Internal
public Set<Project> getProjects()

Returns the set of project to generate this report for. By default, the report is generated for the task's containing project.

Gibt zurück:

The set of files.

setProjects

public void setProjects(Set<Project> projects)

Specifies the set of projects to generate this report for.

Parameter:

projects - The set of projects. Must not be null.

getClientMetaData

@Inject
protected org.gradle.initialization.BuildClientMetaData getClientMetaData()

getTextOutputFactory

@Inject
protected org.gradle.internal.logging.text.StyledTextOutputFactory getTextOutputFactory()