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

Class PatternIncludesArtifactFilter

java.lang.Object

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

All Implemented Interfaces:

ArtifactFilter, StatisticsReportingArtifactFilter

Direct Known Subclasses:

PatternExcludesArtifactFilter

public class PatternIncludesArtifactFilter
extends Object
implements ArtifactFilter, StatisticsReportingArtifactFilter

TODO: include in maven-artifact in future

Author:

Brett Porter

See Also:

StrictPatternIncludesArtifactFilter

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(Artifact artifact)	addFilteredArtifact.
protected String	getFilterDescription()	getFilterDescription.
protected String	getPatternsAsString()	getPatternsAsString.
boolean	hasMissedCriteria()	hasMissedCriteria.
boolean	include(Artifact artifact)
protected boolean	patternMatches(Artifact artifact)	patternMatches.
void	reportFilteredArtifacts(org.codehaus.plexus.logging.Logger logger)	reportFilteredArtifacts.
void	reportMissedCriteria(org.codehaus.plexus.logging.Logger logger)	reportMissedCriteria.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

include

public boolean include(Artifact artifact)

Specified by:

include in interface ArtifactFilter

patternMatches

protected boolean patternMatches(Artifact artifact)

patternMatches.

Parameters:

artifact - to check for.

Returns:

true if the match is true false otherwise.

addFilteredArtifact

protected void addFilteredArtifact(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.