Class RequireFilesSize

java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
org.apache.maven.enforcer.rules.files.RequireFilesSize
All Implemented Interfaces:
EnforcerRuleBase
@Named("requireFilesSize") public final class RequireFilesSize extends AbstractStandardEnforcerRule
Rule to validate the main artifact is within certain size constraints.
Author:
brianf, Roman Stumm

  • Constructor Details

    • RequireFilesSize

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

  • Method Details

    • 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.
      Throws:
      EnforcerRuleException - the enforcer rule exception

    • getCacheId

      public 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.

      Returns:
      id to be used by the Enforcer to determine uniqueness of cache results. Return null disable cache of rule executing.

    • setMaxsize

      public void setMaxsize(long maxsize)

    • setMinsize

      public void setMinsize(long minsize)

    • setRecursive

      public void setRecursive(boolean recursive)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setLog

      public void setLog(EnforcerLogger log)
      Used by EnforcerMojo to inject logger instance
      Specified by:
      setLog in interface EnforcerRuleBase
      Parameters:
      log - an EnforcerLogger instance

    • getLog

      public EnforcerLogger getLog()
      Provide an EnforcerLogger instance for Rule

      NOTICE A logger is not available in constructors.

      Returns:
      an EnforcerLogger instance