Package org.apache.maven.shared.artifact.filter

Class PatternIncludesArtifactFilter

java.lang.Object

org.apache.maven.shared.artifact.filter.PatternIncludesArtifactFilter

All Implemented Interfaces:

org.apache.maven.artifact.resolver.filter.ArtifactFilter, StatisticsReportingArtifactFilter

Direct Known Subclasses:

PatternExcludesArtifactFilter

public class PatternIncludesArtifactFilter
extends Object
implements org.apache.maven.artifact.resolver.filter.ArtifactFilter, StatisticsReportingArtifactFilter

TODO: include in maven-artifact in future

See Also:

• StrictPatternIncludesArtifactFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	PatternIncludesArtifactFilter.AndPattern	Simple pattern which performs a logical AND between one or more patterns.
(package private) static class	PatternIncludesArtifactFilter.EqPattern	Looks for an exact match in the gatv coordinates between posMin and posMax (both inclusives)
(package private) static class	PatternIncludesArtifactFilter.MatchAllPattern	Matches all input
(package private) static class	PatternIncludesArtifactFilter.NegativePattern	Negative pattern
(package private) static class	PatternIncludesArtifactFilter.OrPattern	Simple pattern which performs a logical OR between one or more patterns.
(package private) static class	PatternIncludesArtifactFilter.Pattern	Abstract class for patterns
(package private) static class	PatternIncludesArtifactFilter.PosPattern	A positional matching pattern, to check if a token in the gatv coordinates having a position between posMin and posMax (both inclusives) can match the pattern.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	actTransitively	Whether the dependency trail should be checked
private static final char[]	ANY
private static final char[]	EMPTY
private final List<org.apache.maven.artifact.Artifact>	filteredArtifact	Set of artifacts that have been filtered out
private final Set<PatternIncludesArtifactFilter.Pattern>	patterns	Holds the set of compiled patterns
private final Set<PatternIncludesArtifactFilter.Pattern>	patternsTriggered	Set of patterns that have been triggered
private final Map<Integer,Map<String,PatternIncludesArtifactFilter.Pattern>>	simplePatterns	Holds simple patterns: those that can use direct matching

Constructor Summary

Constructors

Constructor	Description
PatternIncludesArtifactFilter(Collection<String> patterns)	Constructor for PatternIncludesArtifactFilter.
PatternIncludesArtifactFilter(Collection<String> patterns, boolean actTransitively)	Constructor for PatternIncludesArtifactFilter.

Method Summary

Modifier and Type	Method	Description
protected void	addFilteredArtifact(org.apache.maven.artifact.Artifact artifact)	addFilteredArtifact.
private static PatternIncludesArtifactFilter.Pattern	all(String pattern)	Creates a match-all pattern
private static PatternIncludesArtifactFilter.Pattern	and(String pattern, PatternIncludesArtifactFilter.Pattern... patterns)	Creates an AND pattern
private static PatternIncludesArtifactFilter.Pattern	and(PatternIncludesArtifactFilter.Pattern... patterns)	Creates an AND pattern
(package private) static char[]	anyOrChars(char[] str)
(package private) static PatternIncludesArtifactFilter.Pattern	compile(String pattern)
(package private) static char[]	emptyOrChars(String str)
protected String	getFilterDescription()	getFilterDescription.
protected String	getPatternsAsString()	getPatternsAsString.
boolean	hasMissedCriteria()	hasMissedCriteria.
boolean	include(org.apache.maven.artifact.Artifact artifact)
(package private) static boolean	isVersionIncludedInRange(String version, String range)
private Boolean	match(char[][] gatvCharArray)
(package private) static boolean	match(char[] patArr, char[] strArr, boolean isVersion)
private static PatternIncludesArtifactFilter.Pattern	match(char[] token, int posVal)	Creates a positional matching pattern
private static PatternIncludesArtifactFilter.Pattern	match(char[] token, int posMin, int posMax)	Creates a positional matching pattern
private static PatternIncludesArtifactFilter.Pattern	match(String pattern, char[] token, int posVal)	Creates a positional matching pattern
private static PatternIncludesArtifactFilter.Pattern	match(String pattern, char[] token, int posMin, int posMax)	Creates a positional matching pattern
private static PatternIncludesArtifactFilter.Pattern	or(String pattern, PatternIncludesArtifactFilter.Pattern... patterns)	Creates an OR pattern
private static PatternIncludesArtifactFilter.Pattern	or(PatternIncludesArtifactFilter.Pattern... patterns)	Creates an OR pattern
protected boolean	patternMatches(org.apache.maven.artifact.Artifact artifact)	patternMatches.
void	reportFilteredArtifacts(org.codehaus.plexus.logging.Logger logger)	reportFilteredArtifacts.
void	reportMissedCriteria(org.codehaus.plexus.logging.Logger logger)	reportMissedCriteria.
(package private) static char[][]	tokenizeAndSplit(String pattern)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

patterns

private final Set<PatternIncludesArtifactFilter.Pattern> patterns

Holds the set of compiled patterns

simplePatterns

private final Map<Integer,Map<String,PatternIncludesArtifactFilter.Pattern>> simplePatterns

Holds simple patterns: those that can use direct matching

actTransitively

private final boolean actTransitively

Whether the dependency trail should be checked

patternsTriggered

private final Set<PatternIncludesArtifactFilter.Pattern> patternsTriggered

Set of patterns that have been triggered

filteredArtifact

private final List<org.apache.maven.artifact.Artifact> filteredArtifact

Set of artifacts that have been filtered out

EMPTY

private static final char[] EMPTY

ANY

private static final char[] ANY

Constructor Details

PatternIncludesArtifactFilter

public PatternIncludesArtifactFilter(Collection<String> patterns)

Constructor for PatternIncludesArtifactFilter.

Parameters:

patterns - The pattern to be used.

PatternIncludesArtifactFilter

public PatternIncludesArtifactFilter(Collection<String> patterns,
 boolean actTransitively)

Constructor for PatternIncludesArtifactFilter.

Parameters:

patterns - The pattern to be used.

actTransitively - transitive yes/no.

Method Details

include

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

Specified by:

include in interface org.apache.maven.artifact.resolver.filter.ArtifactFilter

patternMatches

protected boolean patternMatches(org.apache.maven.artifact.Artifact artifact)

patternMatches.

Parameters:

artifact - to check for.

Returns:

true if the match is true false otherwise.

match

private Boolean match(char[][] gatvCharArray)

addFilteredArtifact

protected void addFilteredArtifact(org.apache.maven.artifact.Artifact artifact)

addFilteredArtifact.

Parameters:

artifact - add artifact to the filtered artifacts list.

reportMissedCriteria

public void reportMissedCriteria(org.codehaus.plexus.logging.Logger logger)

reportMissedCriteria.

Specified by:

reportMissedCriteria in interface StatisticsReportingArtifactFilter

Parameters:

logger - the logger

toString

public String toString()

Overrides:

toString in class Object

getPatternsAsString

protected String getPatternsAsString()

getPatternsAsString.

Returns:

pattern as a string.

getFilterDescription

protected String getFilterDescription()

getFilterDescription.

Returns:

description.

reportFilteredArtifacts

public void reportFilteredArtifacts(org.codehaus.plexus.logging.Logger logger)

reportFilteredArtifacts.

Specified by:

reportFilteredArtifacts in interface StatisticsReportingArtifactFilter

Parameters:

logger - the logger

hasMissedCriteria

public boolean hasMissedCriteria()

hasMissedCriteria.

Specified by:

hasMissedCriteria in interface StatisticsReportingArtifactFilter

Returns:

a boolean.

emptyOrChars

static char[] emptyOrChars(String str)

anyOrChars

static char[] anyOrChars(char[] str)

tokenizeAndSplit

static char[][] tokenizeAndSplit(String pattern)

match

static boolean match(char[] patArr,
 char[] strArr,
 boolean isVersion)

isVersionIncludedInRange

static boolean isVersionIncludedInRange(String version,
 String range)

compile

static PatternIncludesArtifactFilter.Pattern compile(String pattern)

match

private static PatternIncludesArtifactFilter.Pattern match(String pattern,
 char[] token,
 int posVal)

Creates a positional matching pattern

match

private static PatternIncludesArtifactFilter.Pattern match(char[] token,
 int posVal)

Creates a positional matching pattern

match

private static PatternIncludesArtifactFilter.Pattern match(String pattern,
 char[] token,
 int posMin,
 int posMax)

Creates a positional matching pattern

match

private static PatternIncludesArtifactFilter.Pattern match(char[] token,
 int posMin,
 int posMax)

Creates a positional matching pattern

and

private static PatternIncludesArtifactFilter.Pattern and(String pattern,
 PatternIncludesArtifactFilter.Pattern... patterns)

Creates an AND pattern

and

private static PatternIncludesArtifactFilter.Pattern and(PatternIncludesArtifactFilter.Pattern... patterns)

Creates an AND pattern

or

private static PatternIncludesArtifactFilter.Pattern or(String pattern,
 PatternIncludesArtifactFilter.Pattern... patterns)

Creates an OR pattern

or

private static PatternIncludesArtifactFilter.Pattern or(PatternIncludesArtifactFilter.Pattern... patterns)

Creates an OR pattern

all

private static PatternIncludesArtifactFilter.Pattern all(String pattern)

Creates a match-all pattern