org.apache.maven.plugins.enforcer

Class RequireReleaseDeps

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.AbstractBanDependencies

org.apache.maven.plugins.enforcer.RequireReleaseDeps

All Implemented Interfaces:

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

public class RequireReleaseDeps
extends AbstractBanDependencies

This rule checks that no snapshots are included.

Version:

$Id$

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	excludes Deprecated. the visibility will be reduced to private with the next major version
boolean	failWhenParentIsSnapshot Deprecated. the visibility will be reduced to private with the next major version
List<String>	includes Deprecated. the visibility will be reduced to private with the next major version
boolean	onlyWhenRelease Deprecated. the visibility will be reduced to private with the next major version

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

message

Constructor Summary

Constructors

Constructor and Description
RequireReleaseDeps()

Method Summary

Methods

Modifier and Type	Method and Description
protected Set<org.apache.maven.artifact.Artifact>	checkDependencies(Set<org.apache.maven.artifact.Artifact> dependencies, org.apache.maven.plugin.logging.Log log) Checks the set of dependencies against the list of excludes.
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) Override parent to allow optional ignore of this rule.
Set<org.apache.maven.artifact.Artifact>	filterArtifacts(Set<org.apache.maven.artifact.Artifact> dependencies)
List<String>	getExcludes()
List<String>	getIncludes()
boolean	isFailWhenParentIsSnapshot()
boolean	isOnlyWhenRelease()
void	setExcludes(List<String> excludes)
void	setFailWhenParentIsSnapshot(boolean failWhenParentIsSnapshot)
void	setIncludes(List<String> includes)
void	setOnlyWhenRelease(boolean onlyWhenRelease)

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

getDependenciesToCheck, getErrorMessage, isSearchTransitive, setSearchTransitive

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

getCacheId, isCacheable, isResultValid

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

getMessage, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

onlyWhenRelease

public boolean onlyWhenRelease

Deprecated. the visibility will be reduced to private with the next major version

Allows this rule to execute only when this project is a release.

See Also:

#setOnlyWhenRelease(boolean)}, #isOnlyWhenRelease()}

failWhenParentIsSnapshot

public boolean failWhenParentIsSnapshot

Deprecated. the visibility will be reduced to private with the next major version

Allows this rule to fail when the parent is defined as a snapshot.

See Also:

#setFailWhenParentIsSnapshot(boolean)}, #isFailWhenParentIsSnapshot()}

excludes

public List<String> excludes

Deprecated. the visibility will be reduced to private with the next major version

Dependencies to ignore when checking for release versions. For example, inter-module dependencies can be excluded from the check and therefore allowed to contain snapshot versions.

See Also:

#setExcludes(List)}, #getExcludes()}

includes

public List<String> includes

Deprecated. the visibility will be reduced to private with the next major version

Dependencies to include when checking for release versions. If any of the included dependencies have snapshot versions, the rule will fail.

See Also:

#setIncludes(List)}, #getIncludes()}

Constructor Detail

RequireReleaseDeps

public RequireReleaseDeps()

Method Detail

execute

public void execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Override parent to allow optional ignore of this rule.

Specified by:

execute in interface org.apache.maven.enforcer.rule.api.EnforcerRule

Overrides:

execute in class AbstractBanDependencies

Parameters:

helper - the enforcerRuleHelper

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException - when an exception occurs

checkDependencies

protected Set<org.apache.maven.artifact.Artifact> checkDependencies(Set<org.apache.maven.artifact.Artifact> dependencies,
                                                        org.apache.maven.plugin.logging.Log log)
                                                             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Checks the set of dependencies against the list of excludes.

Specified by:

checkDependencies in class AbstractBanDependencies

Parameters:

dependencies - the dependencies

log - the log

Returns:

the sets the

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException - the enforcer rule exception

filterArtifacts

public Set<org.apache.maven.artifact.Artifact> filterArtifacts(Set<org.apache.maven.artifact.Artifact> dependencies)

isOnlyWhenRelease

public final boolean isOnlyWhenRelease()

setOnlyWhenRelease

public final void setOnlyWhenRelease(boolean onlyWhenRelease)

isFailWhenParentIsSnapshot

public final boolean isFailWhenParentIsSnapshot()

setFailWhenParentIsSnapshot

public final void setFailWhenParentIsSnapshot(boolean failWhenParentIsSnapshot)

setExcludes

public final void setExcludes(List<String> excludes)

getExcludes

public final List<String> getExcludes()

setIncludes

public void setIncludes(List<String> includes)

getIncludes

public List<String> getIncludes()