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

Class AbstractArtifactFeatureFilter

java.lang.Object

org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter

org.apache.maven.shared.artifact.filter.collection.AbstractArtifactFeatureFilter

All Implemented Interfaces:

ArtifactsFilter

Direct Known Subclasses:

ArtifactIdFilter, ClassifierFilter, GroupIdFilter, TypeFilter

public abstract class AbstractArtifactFeatureFilter
extends AbstractArtifactsFilter

This is the common base class of ClassifierFilter and TypeFilter

Version:

$Id: AbstractArtifactFeatureFilter.java 1716978 2015-11-28 14:47:04Z khmarbaise $

Author:

Richard van der Hoff

Constructor Summary

Constructors

Constructor	Description
AbstractArtifactFeatureFilter(java.lang.String include, java.lang.String exclude)

Method Summary

Modifier and Type	Method	Description
protected boolean	compareFeatures(java.lang.String lhs, java.lang.String rhs)	Allows Feature comparison to be customized
java.util.Set<org.apache.maven.artifact.Artifact>	filter(java.util.Set<org.apache.maven.artifact.Artifact> artifacts)	This function determines if filtering needs to be performed.
protected abstract java.lang.String	getArtifactFeature(org.apache.maven.artifact.Artifact artifact)	Should return the type or classifier of the given artifact, so that we can filter it
java.util.List<java.lang.String>	getExcludes()
java.util.List<java.lang.String>	getIncludes()
void	setExcludes(java.lang.String excludeString)
void	setIncludes(java.lang.String includeString)

Methods inherited from class org.apache.maven.shared.artifact.filter.collection.AbstractArtifactsFilter

isArtifactIncluded

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractArtifactFeatureFilter

public AbstractArtifactFeatureFilter(java.lang.String include,
                                     java.lang.String exclude)

Parameters:

include - comma separated list with includes.

exclude - comma separated list with excludes.

Method Detail

filter

public java.util.Set<org.apache.maven.artifact.Artifact> filter(java.util.Set<org.apache.maven.artifact.Artifact> artifacts)

This function determines if filtering needs to be performed. Includes are processed before Excludes.

Parameters:

artifacts - the set of dependencies to filter.

Returns:

a Set of filtered dependencies.

getArtifactFeature

protected abstract java.lang.String getArtifactFeature(org.apache.maven.artifact.Artifact artifact)

Should return the type or classifier of the given artifact, so that we can filter it

Parameters:

artifact - artifact to return type or classifier of

Returns:

type or classifier

setExcludes

public void setExcludes(java.lang.String excludeString)

Parameters:

excludeString - comma separated list with excludes.

setIncludes

public void setIncludes(java.lang.String includeString)

Parameters:

includeString - comma separated list with includes.

getExcludes

public java.util.List<java.lang.String> getExcludes()

Returns:

Returns the excludes.

getIncludes

public java.util.List<java.lang.String> getIncludes()

Returns:

Returns the includes.

compareFeatures

protected boolean compareFeatures(java.lang.String lhs,
                                  java.lang.String rhs)

Allows Feature comparison to be customized

Parameters:

lhs - String artifact's feature

rhs - String feature from exclude or include list

Returns:

boolean true if features match