Package org.gradle.plugin.devel.tasks
Class ValidateTaskProperties
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.util.Configurable<Task>
@Incubating
@CacheableTask
public class ValidateTaskProperties
extends org.gradle.api.internal.ConventionTask
implements VerificationTask
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:
- 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_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe classes to validate.protected org.gradle.internal.classloader.ClassLoaderFactory
The classpath used to load the classes under validation.protected org.gradle.api.internal.DocumentationRegistry
boolean
Returns whether the build should break when the verifications performed by this task detects a warning.boolean
Specifies whether the build should break when the verifications performed by this task fail.Returns the output file to store the report in.void
setClasses
(FileCollection classes) Sets the classes to validate.void
setClasspath
(FileCollection classpath) Sets the classpath used to load the classes under validation.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
setOutputFile
(File outputFile) Sets the output file to store the report in.void
setOutputFile
(Object outputFile) Sets the output file to store the report in.void
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
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
-
Constructor Details
-
ValidateTaskProperties
public ValidateTaskProperties()
-
-
Method Details
-
validateTaskClasses
- Throws:
IOException
-
getIgnoreFailures
public boolean getIgnoreFailures()Specifies whether the build should break when the verifications performed by this task fail.- Specified by:
getIgnoreFailures
in interfaceVerificationTask
- 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 interfaceVerificationTask
- Parameters:
ignoreFailures
- false to break the build on failure, true to ignore the failures. The default is false.
-
getClasses
The classes to validate.- Since:
- 4.0
-
setClasses
Sets the classes to validate.- Since:
- 4.0
-
getClasspath
The classpath used to load the classes under validation. -
setClasspath
Sets the classpath used to load the classes under validation. -
getFailOnWarning
Returns whether the build should break when the verifications performed by this task detects a warning. -
getOutputFile
Returns the output file to store the report in. -
setOutputFile
Sets the output file to store the report in.- Since:
- 4.0
-
setOutputFile
Sets the output file to store the report in. -
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 isfalse
.
-
getClassLoaderFactory
@Inject protected org.gradle.internal.classloader.ClassLoaderFactory getClassLoaderFactory() -
getDocumentationRegistry
@Inject protected org.gradle.api.internal.DocumentationRegistry getDocumentationRegistry()
-