AnimalSniffer (gradle-animalsniffer-plugin 1.7.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', 'Println'])
@groovy.transform.CompileStatic
@org.gradle.api.tasks.CacheableTask
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, TASK_CONSTRUCTOR_ARGS`

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`	`classpath` Classpath used for compilation (if not included in signature)
`boolean`	`debug` Configuration debug output
`java.lang.Iterable<java.lang.String>`	`ignoreClasses` Extra allowed classes, not mentioned in signature, but allowed for usage.
`boolean`	`ignoreFailures` Whether or not the build should break when the verifications performed by this task fail.
`java.util.Set<java.io.File>`	`sourcesDirs` Source directories

Constructor Summary

Constructors
Constructor and description
`AnimalSniffer ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`org.gradle.api.internal.project.IsolatedAntBuilder`	`getAntBuilder()`
	`org.gradle.api.internal.CollectionCallbackActionDecorator`	`getCallbackActionDecorator()`
	`org.gradle.internal.reflect.Instantiator`	`getInstantiator()`
	`AnimalSnifferReports`	`getReports()` Returns the reports to be generated by this task.
	`org.gradle.api.file.FileTree`	`getSource()`
	`void`	`printTaskConfig(java.lang.String path)`
	`void`	`processErrors(ReportCollector collector)`
	`static void`	`recoverOriginalListener(java.lang.Object project, java.lang.Object original)` Recover original listener after execution.
	`static void`	`replaceBuildListener(java.lang.Object project, ReportCollector handler)` Due to many classloaders used by AntBuilder, have to avoid ant classes in custom listener.
	`AnimalSnifferReports`	`reports(groovy.lang.Closure closure)`
	`AnimalSnifferReports`	`reports(org.gradle.api.Action<? super AnimalSnifferReports> action)`
	`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#include(java.lang.Iterable), org.gradle.api.tasks.SourceTask#include(java.lang.Iterable), org.gradle.api.tasks.SourceTask#include(org.gradle.api.specs.Spec), org.gradle.api.tasks.SourceTask#include(org.gradle.api.specs.Spec), org.gradle.api.tasks.SourceTask#include(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#include(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#include([Ljava.lang.String;), org.gradle.api.tasks.SourceTask#include([Ljava.lang.String;), org.gradle.api.tasks.SourceTask#getSource(), org.gradle.api.tasks.SourceTask#getExcludes(), org.gradle.api.tasks.SourceTask#getIncludes(), org.gradle.api.tasks.SourceTask#exclude(org.gradle.api.specs.Spec), 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(java.lang.Iterable), org.gradle.api.tasks.SourceTask#exclude([Ljava.lang.String;), org.gradle.api.tasks.SourceTask#exclude([Ljava.lang.String;), org.gradle.api.tasks.SourceTask#exclude(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#exclude(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#setExcludes(java.lang.Iterable), org.gradle.api.tasks.SourceTask#setExcludes(java.lang.Iterable), org.gradle.api.tasks.SourceTask#setIncludes(java.lang.Iterable), org.gradle.api.tasks.SourceTask#setIncludes(java.lang.Iterable), org.gradle.api.tasks.SourceTask#setSource(org.gradle.api.file.FileTree), org.gradle.api.tasks.SourceTask#setSource(java.lang.Object), org.gradle.api.tasks.SourceTask#getConventionMapping(), org.gradle.api.tasks.SourceTask#conventionMapping(java.lang.String, java.util.concurrent.Callable), org.gradle.api.tasks.SourceTask#conventionMapping(java.lang.String, groovy.lang.Closure), 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#setProperty(java.lang.String, java.lang.Object), org.gradle.api.tasks.SourceTask#getLogger(), org.gradle.api.tasks.SourceTask#getActions(), org.gradle.api.tasks.SourceTask#getState(), org.gradle.api.tasks.SourceTask#getState(), org.gradle.api.tasks.SourceTask#getPath(), org.gradle.api.tasks.SourceTask#getExtensions(), org.gradle.api.tasks.SourceTask#getDescription(), org.gradle.api.tasks.SourceTask#hasProperty(java.lang.String), org.gradle.api.tasks.SourceTask#configure(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#configure(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#setEnabled(boolean), org.gradle.api.tasks.SourceTask#property(java.lang.String), org.gradle.api.tasks.SourceTask#getGroup(), org.gradle.api.tasks.SourceTask#getInputs(), org.gradle.api.tasks.SourceTask#getInputs(), org.gradle.api.tasks.SourceTask#usesService(org.gradle.api.provider.Provider), org.gradle.api.tasks.SourceTask#getAnt(), org.gradle.api.tasks.SourceTask#getLogging(), org.gradle.api.tasks.SourceTask#getLogging(), org.gradle.api.tasks.SourceTask#setGroup(java.lang.String), org.gradle.api.tasks.SourceTask#getDidWork(), org.gradle.api.tasks.SourceTask#getTimeout(), org.gradle.api.tasks.SourceTask#getEnabled(), org.gradle.api.tasks.SourceTask#getOutputs(), org.gradle.api.tasks.SourceTask#getOutputs(), org.gradle.api.tasks.SourceTask#getDestroyables(), org.gradle.api.tasks.SourceTask#getLocalState(), org.gradle.api.tasks.SourceTask#getTemporaryDir(), org.gradle.api.tasks.SourceTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.tasks.SourceTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.tasks.SourceTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.tasks.SourceTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.tasks.SourceTask#onlyIf(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#dependsOn([Ljava.lang.Object;), org.gradle.api.tasks.SourceTask#getDependsOn(), org.gradle.api.tasks.SourceTask#setDidWork(boolean), 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#doFirst(java.lang.String, org.gradle.api.Action), org.gradle.api.tasks.SourceTask#doFirst(org.gradle.api.Action), org.gradle.api.tasks.SourceTask#doFirst(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#doLast(groovy.lang.Closure), org.gradle.api.tasks.SourceTask#doLast(java.lang.String, org.gradle.api.Action), org.gradle.api.tasks.SourceTask#doLast(org.gradle.api.Action), org.gradle.api.tasks.SourceTask#setActions(java.util.List), org.gradle.api.tasks.SourceTask#setDependsOn(java.lang.Iterable), org.gradle.api.tasks.SourceTask#getFinalizedBy(), org.gradle.api.tasks.SourceTask#getShouldRunAfter(), org.gradle.api.tasks.SourceTask#getMustRunAfter(), org.gradle.api.tasks.SourceTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.tasks.SourceTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.tasks.SourceTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.tasks.SourceTask#getProject(), org.gradle.api.tasks.SourceTask#setDescription(java.lang.String), org.gradle.api.tasks.SourceTask#getTaskDependencies(), org.gradle.api.tasks.SourceTask#getTaskDependencies(), org.gradle.api.tasks.SourceTask#setImpliesSubProjects(boolean), org.gradle.api.tasks.SourceTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.gradle.api.tasks.SourceTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.tasks.SourceTask#getRequiredServices(), org.gradle.api.tasks.SourceTask#setLoggerMessageRewriter(org.gradle.internal.logging.slf4j.ContextAwareTaskLogger$MessageRewriter), org.gradle.api.tasks.SourceTask#getImpliesSubProjects(), org.gradle.api.tasks.SourceTask#getTemporaryDirFactory(), org.gradle.api.tasks.SourceTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.tasks.SourceTask#isEnabled(), org.gradle.api.tasks.SourceTask#hasTaskActions(), org.gradle.api.tasks.SourceTask#getTaskActions(), org.gradle.api.tasks.SourceTask#getOnlyIf(), org.gradle.api.tasks.SourceTask#isHasCustomActions(), org.gradle.api.tasks.SourceTask#getStandardOutputCapture(), org.gradle.api.tasks.SourceTask#getAsDynamicObject(), org.gradle.api.tasks.SourceTask#getConvention(), org.gradle.api.tasks.SourceTask#getTaskIdentity(), org.gradle.api.tasks.SourceTask#getSharedResources(), org.gradle.api.tasks.SourceTask#getIdentityPath(), org.gradle.api.tasks.SourceTask#wait(long), org.gradle.api.tasks.SourceTask#wait(long, int), org.gradle.api.tasks.SourceTask#wait(), org.gradle.api.tasks.SourceTask#equals(java.lang.Object), org.gradle.api.tasks.SourceTask#toString(), org.gradle.api.tasks.SourceTask#hashCode(), org.gradle.api.tasks.SourceTask#getClass(), org.gradle.api.tasks.SourceTask#notify(), org.gradle.api.tasks.SourceTask#notifyAll()

- Property Detail
  - @org.gradle.api.tasks.Classpath @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.SkipWhenEmpty @org.gradle.api.tasks.Classpath @org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection animalsnifferSignatures
    
    Signature files used for checks.
  - @org.gradle.api.tasks.Input @java.util.Optional java.lang.String annotation
    
    Annotation class name to avoid check
  - @org.gradle.api.tasks.CompileClasspath @org.gradle.api.tasks.InputFiles @java.util.Optional org.gradle.api.file.FileCollection classpath
    
    Classpath used for compilation (if not included in signature)
  - @java.io.Console boolean debug
    
    Configuration debug output
  - @org.gradle.api.tasks.Input @java.util.Optional java.lang.Iterable<java.lang.String> ignoreClasses
    
    Extra allowed classes, not mentioned in signature, but allowed for usage. Most commonly, when some classes target newer jdk version.
    See docs for more info.
  - @java.io.Console boolean ignoreFailures
    
    Whether or not the build should break when the verifications performed by this task fail.
  - @org.gradle.api.tasks.InputFiles @org.gradle.api.tasks.PathSensitive(PathSensitivity.RELATIVE) java.util.Set<java.io.File> 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.api.internal.CollectionCallbackActionDecorator getCallbackActionDecorator()
  - @javax.inject.Inject org.gradle.internal.reflect.Instantiator getInstantiator()
  - @org.gradle.api.tasks.Nested @java.lang.Override AnimalSnifferReports getReports()
    
    Returns the reports to be generated by this task.
  - @java.lang.Override @org.gradle.api.tasks.PathSensitive(PathSensitivity.RELATIVE) org.gradle.api.file.FileTree getSource()
  - void printTaskConfig(java.lang.String path)
  - void processErrors(ReportCollector collector)
  - @groovy.transform.CompileStatic(TypeCheckingMode.SKIP) static void recoverOriginalListener(java.lang.Object project, java.lang.Object original)
    
    Recover original listener after execution.
    Parameters:
    project - ant project
    original - original listener
  - @groovy.transform.CompileStatic(TypeCheckingMode.SKIP) static void replaceBuildListener(java.lang.Object project, ReportCollector handler)
    
    Due to many classloaders used by AntBuilder, have to avoid ant classes in custom listener. Use jdk proxy to register custom listener.
    Parameters:
    project - ant project
    handler - proxy handler
  - @java.lang.Override @java.lang.SuppressWarnings('ConfusingMethodName') AnimalSnifferReports reports(@groovy.lang.DelegatesTo(value = AnimalSnifferReports, strategy = Closure.DELEGATE_FIRST) groovy.lang.Closure closure)
  - @java.lang.Override @java.lang.SuppressWarnings('ConfusingMethodName') AnimalSnifferReports reports(org.gradle.api.Action<? super AnimalSnifferReports> action)
  - @org.gradle.api.tasks.TaskAction @java.lang.SuppressWarnings(['CatchException', 'VariableName']) @groovy.transform.CompileStatic(TypeCheckingMode.SKIP) 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.Classpath @org.gradle.api.tasks.InputFiles org.gradle.api.file.FileCollection animalsnifferClasspath

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

@org.gradle.api.tasks.Input @java.util.Optional java.lang.String annotation

@org.gradle.api.tasks.CompileClasspath @org.gradle.api.tasks.InputFiles @java.util.Optional org.gradle.api.file.FileCollection classpath

@java.io.Console boolean debug

@org.gradle.api.tasks.Input @java.util.Optional java.lang.Iterable<java.lang.String> ignoreClasses

@java.io.Console boolean ignoreFailures

@org.gradle.api.tasks.InputFiles @org.gradle.api.tasks.PathSensitive(PathSensitivity.RELATIVE) java.util.Set<java.io.File> 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.api.internal.CollectionCallbackActionDecorator getCallbackActionDecorator()

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

@org.gradle.api.tasks.Nested @java.lang.Override AnimalSnifferReports getReports()

@java.lang.Override @org.gradle.api.tasks.PathSensitive(PathSensitivity.RELATIVE) org.gradle.api.file.FileTree getSource()

void printTaskConfig(java.lang.String path)

void processErrors(ReportCollector collector)

@groovy.transform.CompileStatic(TypeCheckingMode.SKIP) static void recoverOriginalListener(java.lang.Object project, java.lang.Object original)

@groovy.transform.CompileStatic(TypeCheckingMode.SKIP) static void replaceBuildListener(java.lang.Object project, ReportCollector handler)

@java.lang.Override @java.lang.SuppressWarnings('ConfusingMethodName') AnimalSnifferReports reports(@groovy.lang.DelegatesTo(value = AnimalSnifferReports, strategy = Closure.DELEGATE_FIRST) groovy.lang.Closure closure)

@java.lang.Override @java.lang.SuppressWarnings('ConfusingMethodName') AnimalSnifferReports reports(org.gradle.api.Action<? super AnimalSnifferReports> action)

@org.gradle.api.tasks.TaskAction @java.lang.SuppressWarnings(['CatchException', 'VariableName']) @groovy.transform.CompileStatic(TypeCheckingMode.SKIP) void run()