org.apache.maven.plugins.enforcer

Class AbstractVersionEnforcer

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractVersionEnforcer

All Implemented Interfaces:

EnforcerRule, EnforcerRule2

Direct Known Subclasses:

RequireJavaVersion, RequireMavenVersion

public abstract class AbstractVersionEnforcer
extends AbstractStandardEnforcerRule

Contains the common code to compare a version against a version range.

Version:

$Id$

Author:

Brian Fox

Constructor Summary

Constructors

Constructor and Description
AbstractVersionEnforcer()

Method Summary

Modifier and Type	Method and Description
static boolean	containsVersion(VersionRange allowedRange, ArtifactVersion theVersion) Copied from Artifact.VersionRange.
void	enforceVersion(Log log, String variableName, String requiredVersionRange, ArtifactVersion actualVersion) Compares the specified version to see if it is allowed by the defined version range.
String	getCacheId()
String	getVersion() Gets the required version.
boolean	isCacheable()
boolean	isResultValid(EnforcerRule theCachedRule)
void	setVersion(String theVersion) Specify the required version.

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

getLevel, getMessage, setLevel, setMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.enforcer.rule.api.EnforcerRule

execute

Constructor Detail

AbstractVersionEnforcer

public AbstractVersionEnforcer()

Method Detail

enforceVersion

public void enforceVersion(Log log,
                           String variableName,
                           String requiredVersionRange,
                           ArtifactVersion actualVersion)
                    throws EnforcerRuleException

Compares the specified version to see if it is allowed by the defined version range.

Parameters:

log - the log

variableName - name of variable to use in messages (Example: "Maven" or "Java" etc).

requiredVersionRange - range of allowed versions.

actualVersion - the version to be checked.

Throws:

EnforcerRuleException - the enforcer rule exception

containsVersion

public static boolean containsVersion(VersionRange allowedRange,
                                      ArtifactVersion theVersion)

Copied from Artifact.VersionRange. This is tweaked to handle singular ranges properly. Currently the default containsVersion method assumes a singular version means allow everything. This method assumes that "2.0.4" == "[2.0.4,)"

Parameters:

allowedRange - range of allowed versions.

theVersion - the version to be checked.

Returns:

true if the version is contained by the range.

getCacheId

public String getCacheId()

isCacheable

public boolean isCacheable()

isResultValid

public boolean isResultValid(EnforcerRule theCachedRule)

getVersion

public final String getVersion()

Gets the required version.

Returns:

the required version

setVersion

public final void setVersion(String theVersion)

Specify the required version. Some examples are:

• 2.0.4 Version 2.0.4 and higher (different from Maven meaning)
• [2.0,2.1) Versions 2.0 (included) to 2.1 (not included)
• [2.0,2.1] Versions 2.0 to 2.1 (both included)
• [2.0.5,) Versions 2.0.5 and higher
• (,2.0.5],[2.1.1,) Versions up to 2.0.5 (included) and 2.1.1 or higher

Parameters:

theVersion - the required version to set