Fork me on GitHub

animal-sniffer:check

Full name:

org.codehaus.mojo:animal-sniffer-maven-plugin:1.16:check

Description:

Checks the classes compiled by this module.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: process-classes.

Required Parameters

Name Type Since Description
signature Signature - Signature module to use.
User property is: animal.sniffer.signature.

Optional Parameters

Name Type Since Description
annotations String[] - Annotation names to consider to ignore annotated methods, classes or fields.

By default 'org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement' and 'org.jvnet.animal_sniffer.IgnoreJRERequirement' are used.


excludeDependencies String[] 1.12 A list of artifact patterns to exclude. Patterns can include * as a wildcard match for any whole segment, valid patterns are:
  • groupId:artifactId
  • groupId:artifactId:type
  • groupId:artifactId:type:version
  • groupId:artifactId:type:classifier
  • groupId:artifactId:type:classifier:version

ignoreDependencies boolean - Should dependencies be ignored.
Default value is: true.
ignores String[] - Class names to ignore signatures for (wildcards accepted).
includeDependencies String[] 1.12 A list of artifact patterns to include. Patterns can include * as a wildcard match for any whole segment, valid patterns are:
  • groupId:artifactId
  • groupId:artifactId:type
  • groupId:artifactId:type:version
  • groupId:artifactId:type:classifier
  • groupId:artifactId:type:classifier:version

skip boolean - Should signature checking be skipped?
Default value is: false.
User property is: animal.sniffer.skip.

Parameter Details

annotations:

Annotation names to consider to ignore annotated methods, classes or fields.

By default 'org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement' and 'org.jvnet.animal_sniffer.IgnoreJRERequirement' are used.

  • Type: java.lang.String[]
  • Required: No

excludeDependencies:

A list of artifact patterns to exclude. Patterns can include * as a wildcard match for any whole segment, valid patterns are:
  • groupId:artifactId
  • groupId:artifactId:type
  • groupId:artifactId:type:version
  • groupId:artifactId:type:classifier
  • groupId:artifactId:type:classifier:version
  • Type: java.lang.String[]
  • Since: 1.12
  • Required: No

ignoreDependencies:

Should dependencies be ignored.
  • Type: boolean
  • Required: No
  • Default: true

ignores:

Class names to ignore signatures for (wildcards accepted).
  • Type: java.lang.String[]
  • Required: No

includeDependencies:

A list of artifact patterns to include. Patterns can include * as a wildcard match for any whole segment, valid patterns are:
  • groupId:artifactId
  • groupId:artifactId:type
  • groupId:artifactId:type:version
  • groupId:artifactId:type:classifier
  • groupId:artifactId:type:classifier:version
  • Type: java.lang.String[]
  • Since: 1.12
  • Required: No

signature:

Signature module to use.
  • Type: org.codehaus.mojo.animal_sniffer.maven.Signature
  • Required: Yes
  • User Property: animal.sniffer.signature

skip:

Should signature checking be skipped?
  • Type: boolean
  • Required: No
  • User Property: animal.sniffer.skip
  • Default: false