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:
EnforcerRule
,EnforcerRule2
This rule checks that no snapshots are included.
- Version:
- $Id: RequireReleaseDeps.java 1697215 2015-08-23 16:27:17Z khmarbaise $
-
Field Summary
FieldsModifier and TypeFieldDescriptionDependencies to ignore when checking for release versions.private boolean
Allows this rule to fail when the parent is defined as a snapshot.Dependencies to include when checking for release versions.private boolean
Allows this rule to execute only when this project is a release. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected 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
(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) private org.apache.maven.project.MavenProject
getProject
(EnforcerRuleHelper helper) final boolean
final boolean
final void
setExcludes
(List<String> excludes) final void
setFailWhenParentIsSnapshot
(boolean failWhenParentIsSnapshot) void
setIncludes
(List<String> includes) final 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
getLevel, getMessage, setLevel, setMessage
-
Field Details
-
onlyWhenRelease
private boolean onlyWhenReleaseAllows this rule to execute only when this project is a release. -
failWhenParentIsSnapshot
private boolean failWhenParentIsSnapshotAllows this rule to fail when the parent is defined as a snapshot. -
excludes
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. -
includes
Dependencies to include when checking for release versions. If any of the included dependencies have snapshot versions, the rule will fail.
-
-
Constructor Details
-
RequireReleaseDeps
public RequireReleaseDeps()
-
-
Method Details
-
execute
Override parent to allow optional ignore of this rule.- Specified by:
execute
in interfaceEnforcerRule
- Overrides:
execute
in classAbstractBanDependencies
- Parameters:
helper
- the enforcerRuleHelper- Throws:
EnforcerRuleException
- when an exception occurs
-
getProject
private org.apache.maven.project.MavenProject getProject(EnforcerRuleHelper helper) throws EnforcerRuleException - Parameters:
helper
-- Returns:
- The evaluated
MavenProject
. - Throws:
EnforcerRuleException
-
checkDependencies
protected Set<org.apache.maven.artifact.Artifact> checkDependencies(Set<org.apache.maven.artifact.Artifact> dependencies, org.apache.maven.plugin.logging.Log log) throws EnforcerRuleException Checks the set of dependencies against the list of excludes.- Specified by:
checkDependencies
in classAbstractBanDependencies
- Parameters:
dependencies
- the dependencieslog
- the log- Returns:
- the sets the
- Throws:
EnforcerRuleException
- the enforcer rule exception
-
filterArtifacts
-
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
-
getExcludes
-
setIncludes
-
getIncludes
-