|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
org.apache.maven.plugins.enforcer.AbstractRequireFiles
public abstract class AbstractRequireFiles
Contains the common code to compare an array of files against a requirement.
Field Summary |
---|
Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule |
---|
message |
Constructor Summary | |
---|---|
AbstractRequireFiles()
|
Method Summary | |
---|---|
void |
execute(EnforcerRuleHelper helper)
This is the interface into the rule. |
String |
getCacheId()
If your rule is cacheable, you must return a unique id when parameters or conditions change that would cause the result to be different. |
boolean |
isCacheable()
This tells the system if the results are cacheable at all. |
boolean |
isResultValid(EnforcerRule cachedRule)
If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to allow double checking of the results. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractRequireFiles()
Method Detail |
---|
public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException
EnforcerRule
helper
- The helper provides access to the log, MavenSession and has
helpers to get common components. It is also able to lookup components
by class name.
EnforcerRuleException
- the enforcer rule exceptionpublic String getCacheId()
public boolean isCacheable()
true
if rule is cacheablepublic boolean isResultValid(EnforcerRule cachedRule)
cachedRule
- the cached rule
true
if the stored results are valid for the same id.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |