Package org.apache.maven.enforcer.rules.utils

Class ArtifactMatcher

java.lang.Object

org.apache.maven.enforcer.rules.utils.ArtifactMatcher

public final class ArtifactMatcher
extends Object

This class is used for matching Artifacts against a list of patterns.

Author:

Jakub Senko

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArtifactMatcher.MatchingArtifact	To be used for artifacts which are equivalent for the purposes of the ArtifactMatcher.
static class	ArtifactMatcher.Pattern

Constructor Summary

Constructors

Constructor	Description
ArtifactMatcher(Collection<String> excludeStrings, Collection<String> includeStrings)	Construct class by providing patterns as strings.

Method Summary

Modifier and Type	Method	Description
static boolean	containsVersion(org.apache.maven.artifact.versioning.VersionRange allowedRange, org.apache.maven.artifact.versioning.ArtifactVersion version)	Copied from Artifact.VersionRange.
boolean	match(org.apache.maven.artifact.Artifact artifact)	Check if artifact matches patterns.
boolean	match(org.apache.maven.model.Dependency dependency)	Check if dependency matches patterns.

Methods inherited from class java.lang.Object

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

Constructor Details

ArtifactMatcher

public ArtifactMatcher(Collection<String> excludeStrings,
 Collection<String> includeStrings)

Construct class by providing patterns as strings. Empty strings are ignored.

Parameters:

excludeStrings - includes

includeStrings - excludes

Throws:

NullPointerException - if any of the arguments is null

Method Details

match

public boolean match(org.apache.maven.artifact.Artifact artifact)

Check if artifact matches patterns.

Parameters:

artifact - the artifact to match

Returns:

true if artifact matches any excludePatterns and none of the includePatterns, otherwise false

match

public boolean match(org.apache.maven.model.Dependency dependency)

Check if dependency matches patterns.

Parameters:

dependency - the dependency to match

Returns:

true if dependency matches any excludePatterns and none of the includePatterns, otherwise false

containsVersion

public static boolean containsVersion(org.apache.maven.artifact.versioning.VersionRange allowedRange,
 org.apache.maven.artifact.versioning.ArtifactVersion version)

Copied from Artifact.VersionRange. This is tweaked to handle singular ranges properly. 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

version - the version to be checked

Returns:

true if the version is contained by the range