org.apache.maven.shared.enforcer.rule.api
Interface EnforcerRule


public interface EnforcerRule

Inteface to be implemented by any rules executed by the enforcer.

Version:
$Id: EnforcerRule.java 525004 2007-04-03 02:45:51Z brianf $
Author:
Brian Fox

Method Summary
 void execute(EnforcerRuleHelper helper)
          This is the inteface into the rule.
 

Method Detail

execute

void execute(EnforcerRuleHelper helper)
             throws EnforcerRuleException
This is the inteface 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 at common components. It is also able to look up components by class name.
Throws:
org.apache.maven.plugin.MojoExecutionException
EnforcerRuleException


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.