Class RequireFilesSize
java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
org.apache.maven.enforcer.rules.files.AbstractRequireFiles
org.apache.maven.enforcer.rules.files.RequireFilesSize
- All Implemented Interfaces:
EnforcerRuleBase
Rule to validate the main artifact is within certain size constraints.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) boolean
Check one file.void
execute()
This is the interface into the rule.If the rule is to be cached during session scope, whole executing of Maven build, this id is used as part of the key.(package private) String
Gets the error msg.void
setMaxsize
(long maxsize) void
setMinsize
(long minsize) Methods inherited from class org.apache.maven.enforcer.rules.files.AbstractRequireFiles
getFiles, setAllowNulls, setFilesList, setSatisfyAny, toString
Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
formatLocation, getMessage, setMessage
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getLevel
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
Field Details
-
MAXSIZE
private static final long MAXSIZE- See Also:
-
maxsize
private long maxsizethe max size allowed. -
minsize
private long minsizethe min size allowed. -
errorMsg
The error msg. -
project
private final org.apache.maven.project.MavenProject project
-
-
Constructor Details
-
RequireFilesSize
@Inject public RequireFilesSize(org.apache.maven.project.MavenProject project)
-
-
Method Details
-
execute
Description copied from class:AbstractEnforcerRule
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 and rule level if it should stop or just log the message as a warning.- Overrides:
execute
in classAbstractRequireFiles
- Throws:
EnforcerRuleException
- the enforcer rule exception
-
getCacheId
Description copied from class:AbstractEnforcerRule
If the rule is to be cached during session scope, whole executing of Maven build, this id is used as part of the key.Rule of the same class and the same cache id will be executed once.
- Overrides:
getCacheId
in classAbstractRequireFiles
- Returns:
- id to be used by the Enforcer to determine uniqueness of cache results.
Return
null
disable cache of rule executing.
-
checkFile
Description copied from class:AbstractRequireFiles
Check one file.- Specified by:
checkFile
in classAbstractRequireFiles
- Parameters:
file
- the file- Returns:
true
if successful
-
getErrorMsg
String getErrorMsg()Description copied from class:AbstractRequireFiles
Gets the error msg.- Specified by:
getErrorMsg
in classAbstractRequireFiles
- Returns:
- the error msg
-
setMaxsize
public void setMaxsize(long maxsize) -
setMinsize
public void setMinsize(long minsize)
-