Class CheckSignatureMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.codehaus.mojo.animal_sniffer.maven.CheckSignatureMojo
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
@Mojo(name="check",
defaultPhase=PROCESS_CLASSES,
requiresDependencyResolution=COMPILE,
threadSafe=true)
public class CheckSignatureMojo
extends org.apache.maven.plugin.AbstractMojo
Checks the classes compiled by this module.
- Author:
- Kohsuke Kawaguchi
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String[]
Annotation names to consider to ignore annotated methods, classes or fields.protected org.apache.maven.artifact.factory.ArtifactFactory
protected boolean
Should dependencies be ignored.protected String[]
Class names to ignore signatures for (wildcards accepted).protected org.apache.maven.artifact.repository.ArtifactRepository
protected File
The directory for compiled classes.protected org.apache.maven.project.MavenProject
protected org.apache.maven.artifact.resolver.ArtifactResolver
protected Signature
Signature module to use.protected boolean
Should signature checking be skipped?Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
outputDirectory
@Parameter(defaultValue="${project.build.outputDirectory}", required=true, readonly=true) protected File outputDirectoryThe directory for compiled classes. -
signature
Signature module to use. -
ignores
Class names to ignore signatures for (wildcards accepted). -
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.
-
ignoreDependencies
@Parameter(defaultValue="true") protected boolean ignoreDependenciesShould dependencies be ignored. -
skip
@Parameter(defaultValue="false", property="animal.sniffer.skip") protected boolean skipShould signature checking be skipped? -
resolver
@Component protected org.apache.maven.artifact.resolver.ArtifactResolver resolver -
project
@Parameter(defaultValue="${project}", readonly=true) protected org.apache.maven.project.MavenProject project -
localRepository
@Parameter(defaultValue="${localRepository}", readonly=true) protected org.apache.maven.artifact.repository.ArtifactRepository localRepository -
artifactFactory
@Component protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
-
-
Constructor Details
-
CheckSignatureMojo
public CheckSignatureMojo()
-
-
Method Details
-
setSignature
- Parameters:
signatureId
- A fully-qualified path to a signature jar. This allows users to set a signature for command-line invocations, such as:mvn org.codehaus.mojo:animal-sniffer-maven-plugin:1.15:check -Dsignature=org.codehaus.mojo.signature:java17:1.0
-
execute
public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
-