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
private static class	PatternIncludesArtifactFilter.AndPattern
private static interface	PatternIncludesArtifactFilter.Artifactoid
private static enum	PatternIncludesArtifactFilter.Coordinate
private static class	PatternIncludesArtifactFilter.CoordinateMatchingPattern
private static class	PatternIncludesArtifactFilter.MatchAllPattern	Matches all input
private static class	PatternIncludesArtifactFilter.NegativePattern	Negative pattern
private static class	PatternIncludesArtifactFilter.Pattern

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	actTransitively	Whether the dependency trail should be checked
private static final String	ANY
private final List<org.apache.maven.artifact.Artifact>	filteredArtifact	Set of artifacts that have been filtered out
private static final PatternIncludesArtifactFilter.Pattern	MATCH_ALL_PATTERN
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 static final String	SEP

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
private static PatternIncludesArtifactFilter.Artifactoid	adapt(String depTrailString)	Parses elements of Artifact.getDependencyTrail() list, they are either G:A:T:V or if artifact has classifier G:A:T:C:V, so strictly 4 or 5 segments only.
private static PatternIncludesArtifactFilter.Artifactoid	adapt(org.apache.maven.artifact.Artifact artifact)
protected void	addFilteredArtifact(org.apache.maven.artifact.Artifact artifact)	addFilteredArtifact.
private static PatternIncludesArtifactFilter.Pattern	compile(String pattern)	Compiles pattern string into PatternIncludesArtifactFilter.Pattern.
protected String	getFilterDescription()
protected String	getPatternsAsString()
boolean	hasMissedCriteria()	hasMissedCriteria.
boolean	include(org.apache.maven.artifact.Artifact artifact)
private static boolean	match(String pattern, boolean containsAsterisk, String value)
private Boolean	match(PatternIncludesArtifactFilter.Artifactoid artifactoid)
protected boolean	patternMatches(org.apache.maven.artifact.Artifact artifact)
void	reportFilteredArtifacts(org.slf4j.Logger logger)	reportFilteredArtifacts.
void	reportMissedCriteria(org.slf4j.Logger logger)	reportMissedCriteria.
private static String[]	splitAndTokenize(String pattern)	Splits the pattern string into tokens, replacing empty tokens with ANY for patterns like ::val so it retains the position of token.
private static PatternIncludesArtifactFilter.Pattern	toPattern(String pattern, String token, PatternIncludesArtifactFilter.Coordinate... coordinates)
private static PatternIncludesArtifactFilter.Pattern	toPattern(String token, PatternIncludesArtifactFilter.Coordinate... coordinates)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SEP

private static final String SEP

patterns

private final Set<PatternIncludesArtifactFilter.Pattern> patterns

Holds the set of compiled patterns

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

ANY

private static final String ANY

See Also:

• Constant Field Values

MATCH_ALL_PATTERN

private static final PatternIncludesArtifactFilter.Pattern MATCH_ALL_PATTERN

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)

match

private Boolean match(PatternIncludesArtifactFilter.Artifactoid artifactoid)

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.slf4j.Logger logger)

Description copied from interface: StatisticsReportingArtifactFilter

reportMissedCriteria.

Specified by:

reportMissedCriteria in interface StatisticsReportingArtifactFilter

Parameters:

logger - the logger

toString

public String toString()

Overrides:

toString in class Object

getPatternsAsString

protected String getPatternsAsString()

getFilterDescription

protected String getFilterDescription()

reportFilteredArtifacts

public void reportFilteredArtifacts(org.slf4j.Logger logger)

Description copied from interface: StatisticsReportingArtifactFilter

reportFilteredArtifacts.

Specified by:

reportFilteredArtifacts in interface StatisticsReportingArtifactFilter

Parameters:

logger - the logger

hasMissedCriteria

public boolean hasMissedCriteria()

Description copied from interface: StatisticsReportingArtifactFilter

hasMissedCriteria.

Specified by:

hasMissedCriteria in interface StatisticsReportingArtifactFilter

Returns:

true if missed criteria; false otherwise.

adapt

private static PatternIncludesArtifactFilter.Artifactoid adapt(org.apache.maven.artifact.Artifact artifact)

adapt

private static PatternIncludesArtifactFilter.Artifactoid adapt(String depTrailString)

Parses elements of Artifact.getDependencyTrail() list, they are either G:A:T:V or if artifact has classifier G:A:T:C:V, so strictly 4 or 5 segments only.

splitAndTokenize

private static String[] splitAndTokenize(String pattern)

Splits the pattern string into tokens, replacing empty tokens with ANY for patterns like ::val so it retains the position of token.

compile

private static PatternIncludesArtifactFilter.Pattern compile(String pattern)

Compiles pattern string into PatternIncludesArtifactFilter.Pattern. TODO: patterns seems NOT documented anywhere, so best we have is source below. TODO: patterns in some cases (3, 2 tokens) seems ambiguous, we may need to clean up the specs

toPattern

private static PatternIncludesArtifactFilter.Pattern toPattern(String token,
 PatternIncludesArtifactFilter.Coordinate... coordinates)

toPattern

private static PatternIncludesArtifactFilter.Pattern toPattern(String pattern,
 String token,
 PatternIncludesArtifactFilter.Coordinate... coordinates)

match

private static boolean match(String pattern,
 boolean containsAsterisk,
 String value)