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

Class ScopeFilter

java.lang.Object

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

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

All Implemented Interfaces:

ArtifactsFilter

public class ScopeFilter
extends AbstractArtifactsFilter

ScopeFilter class.

Author:

Brian Fox

Constructor Summary

Constructors

Constructor and Description
ScopeFilter(String includeScope, String excludeScope) Constructor for ScopeFilter.

Method Summary

Modifier and Type	Method and Description
Set<org.apache.maven.artifact.Artifact>	filter(Set<org.apache.maven.artifact.Artifact> artifacts) filter.
String	getExcludeScope() Getter for the field excludeScope.
String	getIncludeScope() Getter for the field includeScope.
void	setExcludeScope(String scope) Setter for the field excludeScope.
void	setIncludeScope(String scope) Setter for the field includeScope.

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

ScopeFilter

public ScopeFilter(String includeScope,
                   String excludeScope)

Constructor for ScopeFilter.

Parameters:

includeScope - the scope to be included.

excludeScope - the scope to be excluded.

Method Detail

filter

public Set<org.apache.maven.artifact.Artifact> filter(Set<org.apache.maven.artifact.Artifact> artifacts)
                                               throws ArtifactFilterException

filter.

This function determines if filtering needs to be performed. Excludes are ignored if Includes are used.

Parameters:

artifacts - Artifact

Returns:

Set of artifacts.

Throws:

ArtifactFilterException - in case of a failure.

getIncludeScope

public String getIncludeScope()

Getter for the field includeScope.

Returns:

Returns the includeScope.

setIncludeScope

public void setIncludeScope(String scope)

Setter for the field includeScope.

Parameters:

scope - The includeScope to set.

getExcludeScope

public String getExcludeScope()

Getter for the field excludeScope.

Returns:

Returns the excludeScope.

setExcludeScope

public void setExcludeScope(String scope)

Setter for the field excludeScope.

Parameters:

scope - The excludeScope to set.