Property Detail

• java.lang.String annotation

  Annotation class name used to disable check for annotated class/method/field.

• CheckCacheExtension cache

  Check task has to always load and parse entire classpath. This could be time consuming on large classpath. When cache is enabled, classpath is loaded just once and converted to a signature file, which is much faster to load.

  Cache is disabled by default because of problematic cases when both signature and jars contains the same classes (animalsniffer limitation). Moreover, plugin exclude some rarely used classes from the signature which could lead to confusion (if would be enabled by default).

• boolean debug

  Enable plugin configuration debug output.

• java.util.Collection<java.lang.String> excludeJars

  Jar names to exclude from classpath. Asterisk should be used to mask version part 'slf4j-*'. File names in classpath will be named as artifactId-version (note extension is not counted!).

  Pattern name is actually a regexp. Asterisk is just a simplification, which is replaced to '.+' in real pattern.

  This is required for specific cases when you use 3rd party library signatures and need to exclude library jars to correctly check with signature.

• java.util.Collection<java.lang.String> ignore

  Ignore classes, not mentioned in signature. This does not mean "not check class", this mean "allow class usage". Useful in situations, when some classes target higher java versions and so may use classes not described in signature.

  Shortcut method may be used instead of direct collection assignment (shorter for single record).

  Note: asterisk may be used to ignore all classes in package: com.pkg.*

  See docs for more info.

• org.gradle.api.file.FileCollection signatures

  Signatures to use for the check. By default configurations.signature. Assumed to be used for specific cases when signature for check is built inside project or come from not standard source.

Constructor Detail

• AnimalSnifferExtension(org.gradle.api.Project project)

Method Detail

• @java.lang.SuppressWarnings('ConfusingMethodName') void excludeJars(java.lang.String... names)

  Shortcut for excludeJars.

  Parameters:

  names - jar name patterns to exclude

• @java.lang.SuppressWarnings('ConfusingMethodName') void ignore(java.lang.String... classes)

  Shortcut for ignore.

  Parameters:

  classes - one or more classes, not mentioned in signatures

• void setCache(@groovy.lang.DelegatesTo(value = CheckCacheExtension, strategy = Closure.DELEGATE_FIRST) groovy.lang.Closure cache)

  Parameters:

  cache - cache configuration closure