Package org.apache.maven.enforcer.rules.files

Class RequireFilesSize

  • All Implemented Interfaces:
    EnforcerRuleBase
    @Named("requireFilesSize")
public final class RequireFilesSize
extends AbstractRequireFiles
    Rule to validate the main artifact is within certain size constraints.

    • Field Detail

      • maxsize

        private long maxsize
        the max size allowed.

      • minsize

        private long minsize
        the min size allowed.

      • recursive

        private boolean recursive
        the mode for computing the size when the files are directories.

      • errorMsg

        private java.lang.String errorMsg
        The error msg.

      • project

        private final org.apache.maven.project.MavenProject project

    • Constructor Detail

      • RequireFilesSize

        @Inject
public RequireFilesSize​(org.apache.maven.project.MavenProject project)

    • Method Detail

      • execute

        public void execute()
             throws EnforcerRuleException
        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 class AbstractRequireFiles
        Throws:
        EnforcerRuleException - the enforcer rule exception
        EnforcerRuleError - in order to brake a build immediately

      • getCacheId

        public java.lang.String 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 class AbstractRequireFiles
        Returns:
        id to be used by the Enforcer to determine uniqueness of cache results. Return null disable cache of rule executing.

      • computeLength

        private long computeLength​(java.io.File file)

      • setMaxsize

        public void setMaxsize​(long maxsize)

      • setMinsize

        public void setMinsize​(long minsize)

      • setRecursive

        public void setRecursive​(boolean recursive)