Package org.apache.maven.enforcer.rules
Class AlwaysFail
- 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.AlwaysFail
-
- All Implemented Interfaces:
EnforcerRuleBase
@Named("alwaysFail") public final class AlwaysFail extends AbstractStandardEnforcerRule
Always fail. This rule is useful for testing the Enforcer configuration, or to always fail the build if a particular profile is enabled.
-
-
Constructor Summary
Constructors Constructor Description AlwaysFail()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
This is the interface into the rule.java.lang.String
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
getCacheId, getLevel, getRuleName
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
-
-
-
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.- Specified by:
execute
in classAbstractEnforcerRule
- Throws:
EnforcerRuleException
- the enforcer rule exceptionEnforcerRuleError
- in order to brake a build immediately
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-