animal-sniffer:check

Full name:

org.codehaus.mojo:animal-sniffer-maven-plugin:1.7: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.

Optional Parameters

Name Type Since Description
ignoreDependencies boolean - Should dependencies be ignored.
Default value is: true.
ignores String[] - Class names to ignore signatures for (wildcards accepted).
skip boolean - Should signature checking be skipped?
Default value is: false.

Parameter Details

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

signature:

Signature module to use.
  • Type: org.codehaus.mojo.animal_sniffer.maven.Signature
  • Required: Yes

skip:

Should signature checking be skipped?
  • Type: boolean
  • Required: No
  • Expression: ${animal.sniffer.skip}
  • Default: false