org.apache.maven.plugins.enforcer
Class RequireMavenVersion

java.lang.Object
  org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
      org.apache.maven.plugins.enforcer.AbstractVersionEnforcer
          org.apache.maven.plugins.enforcer.RequireMavenVersion

All Implemented Interfaces:

EnforcerRule

public class RequireMavenVersion
extends AbstractVersionEnforcer

This rule checks that the Maven version is allowed.

Version:

$Id: RequireMavenVersion.java 805190 2009-08-17 22:30:49Z hboutemy $

Author:

Brian Fox

Field Summary

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

version

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

message

Constructor Summary

RequireMavenVersion()

Method Summary

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

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

containsVersion, enforceVersion, getCacheId, getVersion, isCacheable, isResultValid, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

RequireMavenVersion

public RequireMavenVersion()

Method Detail

execute

public void execute(EnforcerRuleHelper helper)
             throws EnforcerRuleException

Description copied from interface: EnforcerRule

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