AnimalSniffer (gradle-animalsniffer-plugin 1.0.1 API)

ru.vyarus.gradle.plugin.animalsniffer.AnimalSniffer

All Implemented Interfaces and Traits:

org.gradle.api.tasks.VerificationTask, org.gradle.api.reporting.Reporting
```
@java.lang.SuppressWarnings('UnnecessaryGetter')
class AnimalSniffer
extends org.gradle.api.tasks.SourceTask
```
AnimalSniffer task is created for each registered source set.
Task is SourceTask, but with root in compile classes dir of current source set. This means that include/exclude may be used, but they wil be applied to compiled classes and not sources.
Authors:
Vyacheslav Rusakov
Since:
14.12.2015

Inherited fields
Fields inherited from class	Fields
`class org.gradle.api.tasks.SourceTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION`
`class org.gradle.api.internal.ConventionTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION`

Properties Summary

Properties
Type	Name and description
`org.gradle.api.file.FileCollection`	`animalsnifferClasspath` The class path containing the Animal Sniffer library to be used.
`org.gradle.api.file.FileCollection`	`animalsnifferSignatures` Signature files used for checks.
`java.lang.String`	`annotation` Annotation class name to avoid check
`org.gradle.api.file.FileCollection`	`classes` Classes, required only for task execution after actual compilation
`org.gradle.api.file.FileCollection`	`classpath` Classpath used for compilation
`boolean`	`ignoreFailures` Whether or not the build should break when the verifications performed by this task fail.
`org.gradle.api.file.SourceDirectorySet`	`sourcesDirs` Source directories

Constructor Summary

Constructors
Constructor and description
`AnimalSniffer ()`

Methods Summary

Methods
Type	Name and description
`org.gradle.api.internal.project.IsolatedAntBuilder`	`getAntBuilder()`
`org.gradle.internal.reflect.Instantiator`	`getInstantiator()`
`AnimalSnifferReports`	`getReports()` Returns the reports to be generated by this task.
`static void`	`replaceBuildListener(java.lang.Object project, java.lang.reflect.InvocationHandler handler)` Due to many classloaders used by AntBuilder, have to avoid ant classes in custom listener.
`AnimalSnifferReports`	`reports(groovy.lang.Closure closure)`
`void`	`run()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.gradle.api.tasks.SourceTask`	org.gradle.api.tasks.SourceTask#source([Ljava.lang.Object;), org.gradle.api.tasks.SourceTask#getSource(), org.gradle.api.tasks.SourceTask#setSource(java.lang.Object), org.gradle.api.tasks.SourceTask#getIncludes(), org.gradle.api.tasks.SourceTask#getExcludes(), org.gradle.api.tasks.SourceTask#setIncludes(java.lang.Iterable), org.gradle.api.tasks.SourceTask#setIncludes(java.lang.Iterable), org.gradle.api.tasks.SourceTask#exclude(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#exclude(org.gradle.api.specs.Spec), org.gradle.api.tasks.SourceTask#exclude(java.lang.Iterable), org.gradle.api.tasks.SourceTask#exclude([Ljava.lang.String;), org.gradle.api.tasks.SourceTask#exclude(java.lang.Iterable), org.gradle.api.tasks.SourceTask#exclude(org.gradle.api.specs.Spec), org.gradle.api.tasks.SourceTask#exclude(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#exclude([Ljava.lang.String;), org.gradle.api.tasks.SourceTask#setExcludes(java.lang.Iterable), org.gradle.api.tasks.SourceTask#setExcludes(java.lang.Iterable), org.gradle.api.tasks.SourceTask#include(org.gradle.api.specs.Spec), org.gradle.api.tasks.SourceTask#include(java.lang.Iterable), org.gradle.api.tasks.SourceTask#include([Ljava.lang.String;), org.gradle.api.tasks.SourceTask#include([Ljava.lang.String;), org.gradle.api.tasks.SourceTask#include(org.gradle.api.specs.Spec), org.gradle.api.tasks.SourceTask#include(java.lang.Iterable), org.gradle.api.tasks.SourceTask#include(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#include(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#conventionMapping(java.lang.String, groovy.lang.Closure), org.gradle.api.tasks.SourceTask#conventionMapping(java.lang.String, java.util.concurrent.Callable), org.gradle.api.tasks.SourceTask#getConventionMapping(), org.gradle.api.tasks.SourceTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.tasks.SourceTask#toString(), org.gradle.api.tasks.SourceTask#compareTo(org.gradle.api.Task), org.gradle.api.tasks.SourceTask#compareTo(java.lang.Object), org.gradle.api.tasks.SourceTask#getName(), org.gradle.api.tasks.SourceTask#execute(), org.gradle.api.tasks.SourceTask#getActions(), org.gradle.api.tasks.SourceTask#getState(), org.gradle.api.tasks.SourceTask#getState(), org.gradle.api.tasks.SourceTask#setName(java.lang.String), org.gradle.api.tasks.SourceTask#getPath(), org.gradle.api.tasks.SourceTask#getExtensions(), org.gradle.api.tasks.SourceTask#getLogger(), org.gradle.api.tasks.SourceTask#configure(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#configure(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#leftShift(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#getDescription(), org.gradle.api.tasks.SourceTask#isEnabled(), org.gradle.api.tasks.SourceTask#property(java.lang.String), org.gradle.api.tasks.SourceTask#onlyIf(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.tasks.SourceTask#getDidWork(), org.gradle.api.tasks.SourceTask#deleteAllActions(), org.gradle.api.tasks.SourceTask#getOutputs(), org.gradle.api.tasks.SourceTask#getOutputs(), org.gradle.api.tasks.SourceTask#getDependsOn(), org.gradle.api.tasks.SourceTask#dependsOn([Ljava.lang.Object;), org.gradle.api.tasks.SourceTask#setActions(java.util.List), org.gradle.api.tasks.SourceTask#setDidWork(boolean), org.gradle.api.tasks.SourceTask#doLast(org.gradle.api.Action), org.gradle.api.tasks.SourceTask#doLast(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#getProject(), org.gradle.api.tasks.SourceTask#doFirst(org.gradle.api.Action), org.gradle.api.tasks.SourceTask#doFirst(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.tasks.SourceTask#setDependsOn(java.lang.Iterable), org.gradle.api.tasks.SourceTask#getEnabled(), org.gradle.api.tasks.SourceTask#getAnt(), org.gradle.api.tasks.SourceTask#getLogging(), org.gradle.api.tasks.SourceTask#getLogging(), org.gradle.api.tasks.SourceTask#hasProperty(java.lang.String), org.gradle.api.tasks.SourceTask#getConvention(), org.gradle.api.tasks.SourceTask#setDescription(java.lang.String), org.gradle.api.tasks.SourceTask#getGroup(), org.gradle.api.tasks.SourceTask#setGroup(java.lang.String), org.gradle.api.tasks.SourceTask#getInputs(), org.gradle.api.tasks.SourceTask#getTemporaryDir(), org.gradle.api.tasks.SourceTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.tasks.SourceTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.tasks.SourceTask#getMustRunAfter(), org.gradle.api.tasks.SourceTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.tasks.SourceTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.tasks.SourceTask#getFinalizedBy(), org.gradle.api.tasks.SourceTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.tasks.SourceTask#getTaskDependencies(), org.gradle.api.tasks.SourceTask#getTaskDependencies(), org.gradle.api.tasks.SourceTask#getShouldRunAfter(), org.gradle.api.tasks.SourceTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.tasks.SourceTask#dependsOnTaskDidWork(), org.gradle.api.tasks.SourceTask#setEnabled(boolean), org.gradle.api.tasks.SourceTask#setProject(org.gradle.api.Project), org.gradle.api.tasks.SourceTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.tasks.SourceTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, java.lang.String, java.util.concurrent.Callable), org.gradle.api.tasks.SourceTask#getAsDynamicObject(), org.gradle.api.tasks.SourceTask#getStandardOutputCapture(), org.gradle.api.tasks.SourceTask#getTaskActions(), org.gradle.api.tasks.SourceTask#getOnlyIf(), org.gradle.api.tasks.SourceTask#getExecuter(), org.gradle.api.tasks.SourceTask#setExecuter(org.gradle.api.internal.tasks.TaskExecuter), org.gradle.api.tasks.SourceTask#addValidator(org.gradle.api.internal.tasks.execution.TaskValidator), org.gradle.api.tasks.SourceTask#getValidators(), org.gradle.api.tasks.SourceTask#setImpliesSubProjects(boolean), org.gradle.api.tasks.SourceTask#getImpliesSubProjects(), org.gradle.api.tasks.SourceTask#getTemporaryDirFactory(), org.gradle.api.tasks.SourceTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.tasks.SourceTask#isHasCustomActions(), org.gradle.api.tasks.SourceTask#wait(), org.gradle.api.tasks.SourceTask#wait(long, int), org.gradle.api.tasks.SourceTask#wait(long), org.gradle.api.tasks.SourceTask#equals(java.lang.Object), org.gradle.api.tasks.SourceTask#hashCode(), org.gradle.api.tasks.SourceTask#getClass(), org.gradle.api.tasks.SourceTask#notify(), org.gradle.api.tasks.SourceTask#notifyAll()
`class org.gradle.api.internal.ConventionTask`	org.gradle.api.internal.ConventionTask#conventionMapping(java.lang.String, groovy.lang.Closure), org.gradle.api.internal.ConventionTask#conventionMapping(java.lang.String, java.util.concurrent.Callable), org.gradle.api.internal.ConventionTask#getConventionMapping(), org.gradle.api.internal.ConventionTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.internal.ConventionTask#toString(), org.gradle.api.internal.ConventionTask#compareTo(org.gradle.api.Task), org.gradle.api.internal.ConventionTask#compareTo(java.lang.Object), org.gradle.api.internal.ConventionTask#getName(), org.gradle.api.internal.ConventionTask#execute(), org.gradle.api.internal.ConventionTask#getActions(), org.gradle.api.internal.ConventionTask#getState(), org.gradle.api.internal.ConventionTask#getState(), org.gradle.api.internal.ConventionTask#setName(java.lang.String), org.gradle.api.internal.ConventionTask#getPath(), org.gradle.api.internal.ConventionTask#getExtensions(), org.gradle.api.internal.ConventionTask#getLogger(), org.gradle.api.internal.ConventionTask#configure(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#configure(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#leftShift(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#getDescription(), org.gradle.api.internal.ConventionTask#isEnabled(), org.gradle.api.internal.ConventionTask#property(java.lang.String), org.gradle.api.internal.ConventionTask#onlyIf(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.ConventionTask#getDidWork(), org.gradle.api.internal.ConventionTask#deleteAllActions(), org.gradle.api.internal.ConventionTask#getOutputs(), org.gradle.api.internal.ConventionTask#getOutputs(), org.gradle.api.internal.ConventionTask#getDependsOn(), org.gradle.api.internal.ConventionTask#dependsOn([Ljava.lang.Object;), org.gradle.api.internal.ConventionTask#setActions(java.util.List), org.gradle.api.internal.ConventionTask#setDidWork(boolean), org.gradle.api.internal.ConventionTask#doLast(org.gradle.api.Action), org.gradle.api.internal.ConventionTask#doLast(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#getProject(), org.gradle.api.internal.ConventionTask#doFirst(org.gradle.api.Action), org.gradle.api.internal.ConventionTask#doFirst(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.ConventionTask#setDependsOn(java.lang.Iterable), org.gradle.api.internal.ConventionTask#getEnabled(), org.gradle.api.internal.ConventionTask#getAnt(), org.gradle.api.internal.ConventionTask#getLogging(), org.gradle.api.internal.ConventionTask#getLogging(), org.gradle.api.internal.ConventionTask#hasProperty(java.lang.String), org.gradle.api.internal.ConventionTask#getConvention(), org.gradle.api.internal.ConventionTask#setDescription(java.lang.String), org.gradle.api.internal.ConventionTask#getGroup(), org.gradle.api.internal.ConventionTask#setGroup(java.lang.String), org.gradle.api.internal.ConventionTask#getInputs(), org.gradle.api.internal.ConventionTask#getTemporaryDir(), org.gradle.api.internal.ConventionTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.internal.ConventionTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.internal.ConventionTask#getMustRunAfter(), org.gradle.api.internal.ConventionTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.internal.ConventionTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.internal.ConventionTask#getFinalizedBy(), org.gradle.api.internal.ConventionTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.internal.ConventionTask#getTaskDependencies(), org.gradle.api.internal.ConventionTask#getTaskDependencies(), org.gradle.api.internal.ConventionTask#getShouldRunAfter(), org.gradle.api.internal.ConventionTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.internal.ConventionTask#dependsOnTaskDidWork(), org.gradle.api.internal.ConventionTask#setEnabled(boolean), org.gradle.api.internal.ConventionTask#setProject(org.gradle.api.Project), org.gradle.api.internal.ConventionTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.internal.ConventionTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, java.lang.String, java.util.concurrent.Callable), org.gradle.api.internal.ConventionTask#getAsDynamicObject(), org.gradle.api.internal.ConventionTask#getStandardOutputCapture(), org.gradle.api.internal.ConventionTask#getTaskActions(), org.gradle.api.internal.ConventionTask#getOnlyIf(), org.gradle.api.internal.ConventionTask#getExecuter(), org.gradle.api.internal.ConventionTask#setExecuter(org.gradle.api.internal.tasks.TaskExecuter), org.gradle.api.internal.ConventionTask#addValidator(org.gradle.api.internal.tasks.execution.TaskValidator), org.gradle.api.internal.ConventionTask#getValidators(), org.gradle.api.internal.ConventionTask#setImpliesSubProjects(boolean), org.gradle.api.internal.ConventionTask#getImpliesSubProjects(), org.gradle.api.internal.ConventionTask#getTemporaryDirFactory(), org.gradle.api.internal.ConventionTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.internal.ConventionTask#isHasCustomActions(), org.gradle.api.internal.ConventionTask#wait(), org.gradle.api.internal.ConventionTask#wait(long, int), org.gradle.api.internal.ConventionTask#wait(long), org.gradle.api.internal.ConventionTask#equals(java.lang.Object), org.gradle.api.internal.ConventionTask#hashCode(), org.gradle.api.internal.ConventionTask#getClass(), org.gradle.api.internal.ConventionTask#notify(), org.gradle.api.internal.ConventionTask#notifyAll()

- Property Detail
  - @org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection animalsnifferClasspath
    
    The class path containing the Animal Sniffer library to be used.
  - @org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection animalsnifferSignatures
    
    Signature files used for checks.
  - java.lang.String annotation
    
    Annotation class name to avoid check
  - @org.gradle.api.tasks.SkipWhenEmpty @org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection classes
    
    Classes, required only for task execution after actual compilation
  - @org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection classpath
    
    Classpath used for compilation
  - boolean ignoreFailures
    
    Whether or not the build should break when the verifications performed by this task fail.
  - org.gradle.api.file.SourceDirectorySet sourcesDirs
    
    Source directories
- Constructor Detail
  - @java.lang.SuppressWarnings('ThisReferenceEscapesConstructor') AnimalSniffer()
- Method Detail
  - @javax.inject.Inject org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
  - @javax.inject.Inject org.gradle.internal.reflect.Instantiator getInstantiator()
  - @java.lang.Override AnimalSnifferReports getReports()
    
    Returns the reports to be generated by this task.
  - static void replaceBuildListener(java.lang.Object project, java.lang.reflect.InvocationHandler handler)
    
    Due to many classloaders used by AntBuilder, have to avoid ant classes in custom listener. To accomplish this jdk proxy used.
    Parameters:
    project - ant project
    handler - proxy handler
  - @java.lang.Override @java.lang.SuppressWarnings('ConfusingMethodName') AnimalSnifferReports reports(groovy.lang.Closure closure)
  - @org.gradle.api.tasks.TaskAction @java.lang.SuppressWarnings('CatchException') void run()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AnimalSniffer

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection animalsnifferClasspath

@org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection animalsnifferSignatures

java.lang.String annotation

@org.gradle.api.tasks.SkipWhenEmpty @org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection classes

@org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection classpath

boolean ignoreFailures

org.gradle.api.file.SourceDirectorySet sourcesDirs

Constructor Detail

@java.lang.SuppressWarnings('ThisReferenceEscapesConstructor') AnimalSniffer()

Method Detail

@javax.inject.Inject org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()

@javax.inject.Inject org.gradle.internal.reflect.Instantiator getInstantiator()

@java.lang.Override AnimalSnifferReports getReports()

static void replaceBuildListener(java.lang.Object project, java.lang.reflect.InvocationHandler handler)

@java.lang.Override @java.lang.SuppressWarnings('ConfusingMethodName') AnimalSnifferReports reports(groovy.lang.Closure closure)

@org.gradle.api.tasks.TaskAction @java.lang.SuppressWarnings('CatchException') void run()