Package org.codehaus.mojo.animal_sniffer.enforcer

Class CheckSignatureRule

java.lang.Object

org.codehaus.mojo.animal_sniffer.enforcer.CheckSignatureRule

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule, org.apache.maven.enforcer.rule.api.EnforcerRuleBase

public class CheckSignatureRule
extends Object
implements org.apache.maven.enforcer.rule.api.EnforcerRule

Created by IntelliJ IDEA.

Since:

Sep 4, 2009 2:44:29 PM

Author:

connollys

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	annotations	Annotation names to consider to ignore annotated methods, classes or fields.
protected boolean	ignoreDependencies	Should dependencies be ignored.
protected String[]	ignores	Class names to ignore signatures for (wildcards accepted).
protected Signature	signature	Signature module to use.

Constructor Summary

Constructors

Constructor	Description
CheckSignatureRule()

Method Summary

Modifier and Type	Method	Description
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
String	getCacheId()
boolean	isCacheable()
boolean	isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule enforcerRule)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.enforcer.rule.api.EnforcerRuleBase

getLevel, setLog

Field Details

signature

protected Signature signature

Signature module to use. //required //parameter

ignores

protected String[] ignores

Class names to ignore signatures for (wildcards accepted). //parameter

annotations

protected String[] 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. //parameter

See Also:

• SignatureChecker.ANNOTATION_FQN
• SignatureChecker.PREVIOUS_ANNOTATION_FQN

ignoreDependencies

protected boolean ignoreDependencies

Should dependencies be ignored. //parameter default-value="true"

Constructor Details

CheckSignatureRule

public CheckSignatureRule()

Method Details

execute

public void execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Specified by:

execute in interface org.apache.maven.enforcer.rule.api.EnforcerRule

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException

isCacheable

public boolean isCacheable()

Specified by:

isCacheable in interface org.apache.maven.enforcer.rule.api.EnforcerRule

isResultValid

public boolean isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule enforcerRule)

Specified by:

isResultValid in interface org.apache.maven.enforcer.rule.api.EnforcerRule

getCacheId

public String getCacheId()

Specified by:

getCacheId in interface org.apache.maven.enforcer.rule.api.EnforcerRule