Package org.gradle.api.tasks.diagnostics
Class AbstractProjectBasedReportTask<T>
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.diagnostics.ConventionReportTask
org.gradle.api.tasks.diagnostics.AbstractProjectBasedReportTask<T>
- Type Parameters:
- T- The report model type
- All Implemented Interfaces:
- Comparable<Task>,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.IConventionAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Task,- Configurable<Task>
- Direct Known Subclasses:
- AbstractDependencyReportTask,- ProjectReportTask,- PropertyReportTask
@Incubating
@DisableCachingByDefault(because="Abstract super-class, not to be instantiated directly")
public abstract class AbstractProjectBasedReportTask<T>
extends ConventionReportTask
The base class for all Project based project report tasks.
- Since:
- 7.6
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected abstract TcalculateReportModelFor(Project project) protected voidgenerateReportFooterFor(Map<org.gradle.api.tasks.diagnostics.internal.ProjectDetails, T> modelsByProjectDetails) Provides a means of printing a customizable footer section below the per-project details body of the report.protected abstract voidgenerateReportFor(org.gradle.api.tasks.diagnostics.internal.ProjectDetails project, T model) protected voidgenerateReportHeaderFor(Map<org.gradle.api.tasks.diagnostics.internal.ProjectDetails, T> modelsByProjectDetails) Provides a means of printing a customizable header section above the per-project details body of the report.Methods inherited from class org.gradle.api.tasks.diagnostics.ConventionReportTaskgetClientMetaData, getOutputFile, getProjectReportDirectory, getProjects, getRenderer, getTextOutputFactory, setOutputFile, setProjectsMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, 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, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
AbstractProjectBasedReportTaskpublic AbstractProjectBasedReportTask()
 
- 
- 
Method Details- 
calculateReportModelFor
- 
generateReportHeaderFor@Incubating protected void generateReportHeaderFor(Map<org.gradle.api.tasks.diagnostics.internal.ProjectDetails, T> modelsByProjectDetails) Provides a means of printing a customizable header section above the per-project details body of the report.By default, there is no header information printed. - Parameters:
- modelsByProjectDetails- information about the projects under report
- Since:
- 8.9
 
- 
generateReportForprotected abstract void generateReportFor(org.gradle.api.tasks.diagnostics.internal.ProjectDetails project, T model) 
 
-