ValidateTaskProperties (Gradle API 5.2.1)

java.lang.Object
- org.gradle.api.internal.AbstractTask
- - org.gradle.api.DefaultTask
  - - org.gradle.api.internal.ConventionTask
    - - org.gradle.plugin.devel.tasks.ValidateTaskProperties

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, VerificationTask, org.gradle.plugin.devel.tasks.internal.ValidateTaskPropertiesBackwardsCompatibleAdapter, org.gradle.util.Configurable<Task>
```
@CacheableTask
public class ValidateTaskProperties
extends org.gradle.api.internal.ConventionTask
implements VerificationTask, org.gradle.plugin.devel.tasks.internal.ValidateTaskPropertiesBackwardsCompatibleAdapter
```
Validates task property annotations.
Task properties must be annotated with one of:
- Properties taken into account during up-to-date checks:
  - @Input, @Nested, @InputFile, @InputDirectory, @InputFiles to mark it as an input to the task.
  - @OutputFile, @OutputDirectory to mark it as an output of the task.
- Properties ignored during up-to-date checks:
  - @Inject marks a Gradle service used by the task.
  - @Console marks a property that only influences the console output of the task.
  - @Internal mark an internal property of the task.
Since:

3.0

Nested Class Summary
- Nested classes/interfaces inherited from interface org.gradle.api.Task
  Task.Namer

Field Summary
- Fields inherited from interface org.gradle.api.Task
  TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors
Constructor Description

ValidateTaskProperties(ObjectFactory objects, ProjectLayout layout)

Constructors
Constructor	Description
`ValidateTaskProperties(ObjectFactory objects, ProjectLayout layout)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`ConfigurableFileCollection`	`getClasses()`	The classes to validate.
`protected org.gradle.internal.classloader.ClassLoaderFactory`	`getClassLoaderFactory()`
`ConfigurableFileCollection`	`getClasspath()`	The classpath used to load the classes under validation.
`protected org.gradle.api.internal.DocumentationRegistry`	`getDocumentationRegistry()`
`boolean`	`getEnableStricterValidation()`	Enable the stricter validation for cacheable tasks for all tasks.
`boolean`	`getFailOnWarning()`	Returns whether the build should break when the verifications performed by this task detects a warning.
`boolean`	`getIgnoreFailures()`	Specifies whether the build should break when the verifications performed by this task fail.
`RegularFileProperty`	`getOutputFile()`	Returns the output file to store the report in.
`void`	`setClasses(FileCollection classes)`	Deprecated. Use `getClasses()`.setFrom instead.
`void`	`setClasspath(FileCollection classpath)`	Deprecated. Use `getClasspath()`.setFrom instead.
`void`	`setEnableStricterValidation(boolean enableStricterValidation)`	Enable the stricter validation for cacheable tasks for all tasks.
`void`	`setFailOnWarning(boolean failOnWarning)`	Specifies whether the build should break when the verifications performed by this task detects a warning.
`void`	`setIgnoreFailures(boolean ignoreFailures)`	Specifies whether the build should break when the verifications performed by this task fail.
`void`	`validateTaskClasses()`

Methods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.DefaultTask
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile

Methods inherited from class org.gradle.api.internal.AbstractTask
appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ValidateTaskProperties
```
@Inject
public ValidateTaskProperties(ObjectFactory objects,
                              ProjectLayout layout)
```
- Method Detail
  - validateTaskClasses
```
public void validateTaskClasses()
                         throws IOException
```
    Throws:
    
    IOException
  - getIgnoreFailures
```
public boolean getIgnoreFailures()
```
    Specifies whether the build should break when the verifications performed by this task fail.
    
    Specified by:
    
    getIgnoreFailures in interface VerificationTask
    
    Returns:
    
    false, when the build should break on failure, true when the failures should be ignored.
  - setIgnoreFailures
```
public void setIgnoreFailures(boolean ignoreFailures)
```
    Specifies whether the build should break when the verifications performed by this task fail.
    
    Specified by:
    
    setIgnoreFailures in interface VerificationTask
    
    Parameters:
    
    ignoreFailures - false to break the build on failure, true to ignore the failures. The default is false.
  - getClasses
```
@PathSensitive(RELATIVE)
@InputFiles
@SkipWhenEmpty
public ConfigurableFileCollection getClasses()
```
    The classes to validate.
    
    Specified by:
    
    getClasses in interface org.gradle.plugin.devel.tasks.internal.ValidateTaskPropertiesBackwardsCompatibleAdapter
    
    Since:
    
    4.0
  - setClasses
```
@Deprecated
public void setClasses(FileCollection classes)
```
    Deprecated.
    Use getClasses().setFrom instead.
    
    Sets the classes to validate.
    
    Since:
    
    4.0
  - getClasspath
```
@Classpath
public ConfigurableFileCollection getClasspath()
```
    The classpath used to load the classes under validation.
    
    Specified by:
    
    getClasspath in interface org.gradle.plugin.devel.tasks.internal.ValidateTaskPropertiesBackwardsCompatibleAdapter
  - setClasspath
```
@Deprecated
public void setClasspath(FileCollection classpath)
```
    Deprecated.
    Use getClasspath().setFrom instead.
    
    Sets the classpath used to load the classes under validation.
  - getFailOnWarning
```
@Input
public boolean getFailOnWarning()
```
    Returns whether the build should break when the verifications performed by this task detects a warning.
  - getEnableStricterValidation
```
@Incubating
@Input
public boolean getEnableStricterValidation()
```
    Enable the stricter validation for cacheable tasks for all tasks.
    
    Since:
    
    5.1
  - setEnableStricterValidation
```
@Incubating
public void setEnableStricterValidation(boolean enableStricterValidation)
```
    Enable the stricter validation for cacheable tasks for all tasks.
    
    Since:
    
    5.1
  - getOutputFile
```
@Optional
@OutputFile
public RegularFileProperty getOutputFile()
```
    Returns the output file to store the report in.
    
    Since:
    
    4.5
  - setFailOnWarning
```
public void setFailOnWarning(boolean failOnWarning)
```
    Specifies whether the build should break when the verifications performed by this task detects a warning.
    
    Parameters:
    
    failOnWarning - true to break the build on warning, false to ignore warnings. The default is false.
  - getClassLoaderFactory
```
@Inject
protected org.gradle.internal.classloader.ClassLoaderFactory getClassLoaderFactory()
```
  - getDocumentationRegistry
```
@Inject
protected org.gradle.api.internal.DocumentationRegistry getDocumentationRegistry()
```

Class ValidateTaskProperties

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Field Summary

Fields inherited from interface org.gradle.api.Task

Constructor Summary

Method Summary

Methods inherited from class org.gradle.api.internal.ConventionTask

Methods inherited from class org.gradle.api.DefaultTask

Methods inherited from class org.gradle.api.internal.AbstractTask

Methods inherited from class java.lang.Object

Constructor Detail

ValidateTaskProperties

Method Detail

validateTaskClasses

getIgnoreFailures

setIgnoreFailures

getClasses

setClasses

getClasspath

setClasspath

getFailOnWarning

getEnableStricterValidation

setEnableStricterValidation

getOutputFile

setFailOnWarning

getClassLoaderFactory

getDocumentationRegistry