@Mojo(name="check",
defaultPhase=PROCESS_CLASSES,
requiresDependencyResolution=COMPILE,
threadSafe=true)
public class CheckSignatureMojo
extends org.apache.maven.plugin.AbstractMojo
Modifier and Type | Field and Description |
---|---|
protected String[] |
annotations
Annotation names to consider to ignore annotated methods, classes or fields.
|
protected org.apache.maven.artifact.factory.ArtifactFactory |
artifactFactory |
protected boolean |
failOnError
Should signature check failures throw an error?
|
protected boolean |
ignoreDependencies
Should dependencies be ignored.
|
protected String[] |
ignores
Class names to ignore signatures for (wildcards accepted).
|
protected org.apache.maven.artifact.repository.ArtifactRepository |
localRepository |
protected File |
outputDirectory
The directory for compiled classes.
|
protected org.apache.maven.project.MavenProject |
project |
protected org.apache.maven.artifact.resolver.ArtifactResolver |
resolver |
protected Signature |
signature
Signature module to use.
|
protected boolean |
skip
Should signature checking be skipped?
|
Constructor and Description |
---|
CheckSignatureMojo() |
Modifier and Type | Method and Description |
---|---|
void |
execute() |
void |
setSignature(String signatureId) |
@Parameter(defaultValue="${project.build.outputDirectory}", required=true, readonly=true) protected File outputDirectory
@Parameter(required=true, property="animal.sniffer.signature") protected Signature signature
@Parameter protected String[] ignores
@Parameter protected String[] annotations
By default 'org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement' and 'org.jvnet.animal_sniffer.IgnoreJRERequirement' are used.
@Parameter(defaultValue="true") protected boolean ignoreDependencies
@Parameter(defaultValue="false", property="animal.sniffer.skip") protected boolean skip
@Parameter(defaultValue="true", property="animal.sniffer.failOnError") protected boolean failOnError
@Component protected org.apache.maven.artifact.resolver.ArtifactResolver resolver
@Parameter(defaultValue="${project}", readonly=true) protected org.apache.maven.project.MavenProject project
@Parameter(defaultValue="${localRepository}", readonly=true) protected org.apache.maven.artifact.repository.ArtifactRepository localRepository
@Component protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
public void setSignature(String signatureId)
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
public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
Copyright © 2008–2018 Codehaus. All rights reserved.