Class AlwaysFail

All Implemented Interfaces:
EnforcerRule, EnforcerRule2

public class AlwaysFail extends AbstractNonCacheableEnforcerRule
Always fail. This rule is useful for testing the Enforcer configuration, or to always fail the build if a particular profile is enabled.
  • Constructor Details

    • AlwaysFail

      public AlwaysFail()
  • Method Details

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