org.apache.maven.plugins.enforcer
Class AlwaysFail

java.lang.Object
  org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
      org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
          org.apache.maven.plugins.enforcer.AlwaysFail

All Implemented Interfaces:

EnforcerRule

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.

Author:

Ben Lidgey

Field Summary

Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

message

Constructor Summary

AlwaysFail()

Method Summary

void	execute(EnforcerRuleHelper helper) This is the interface into the rule.

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

getCacheId, isCacheable, isResultValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlwaysFail

public AlwaysFail()

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.

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