Class RequireFilesSize
- java.lang.Object
-
- org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
-
- org.apache.maven.plugins.enforcer.AbstractRequireFiles
-
- org.apache.maven.plugins.enforcer.RequireFilesSize
-
- All Implemented Interfaces:
EnforcerRule
,EnforcerRule2
public class RequireFilesSize extends AbstractRequireFiles
Rule to validate the main artifact is within certain size constraints.- Author:
- brianf, Roman Stumm
-
-
Constructor Summary
Constructors Constructor Description RequireFilesSize()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute(EnforcerRuleHelper helper)
This is the interface into the rule.long
getMaxsize()
long
getMinsize()
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.void
setMaxsize(long maxsize)
void
setMinsize(long minsize)
-
Methods inherited from class org.apache.maven.plugins.enforcer.AbstractRequireFiles
getCacheId, getFiles, isAllowNulls, setAllowNulls, setFiles
-
Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
getLevel, getMessage, setLevel, setMessage
-
-
-
-
Method Detail
-
execute
public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException
This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag if it should stop or just log the message as a warning.- Specified by:
execute
in interfaceEnforcerRule
- Overrides:
execute
in classAbstractRequireFiles
- Parameters:
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.- Throws:
EnforcerRuleException
- the enforcer rule exception
-
isCacheable
public boolean isCacheable()
This tells the system if the results are cacheable at all. Keep in mind that during forked builds and other things, a given rule may be executed more than once for the same project. This means that even things that change from project to project may still be cacheable in certain instances.- Specified by:
isCacheable
in interfaceEnforcerRule
- Overrides:
isCacheable
in classAbstractRequireFiles
- Returns:
true
if rule is cacheable
-
isResultValid
public 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. Most of the time this can be done by generating unique ids, but sometimes the results of objects returned by the helper need to be queried. You may for example, store certain objects in your rule and then query them later.- Specified by:
isResultValid
in interfaceEnforcerRule
- Overrides:
isResultValid
in classAbstractRequireFiles
- Parameters:
cachedRule
- the cached rule- Returns:
true
if the stored results are valid for the same id.
-
getMaxsize
public long getMaxsize()
-
setMaxsize
public void setMaxsize(long maxsize)
-
getMinsize
public long getMinsize()
-
setMinsize
public void setMinsize(long minsize)
-
-