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

Class FilterArtifacts

java.lang.Object

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

public class FilterArtifacts
extends Object

FilterArtifacts class.

Author:

Brian Fox

Constructor Summary

Constructors

Constructor and Description
FilterArtifacts() Created new instance.

Method Summary

Modifier and Type	Method and Description
void	addFilter(ArtifactsFilter filter) Appends the specified element to the end of this list.
void	addFilter(int index, ArtifactsFilter filter) Inserts the specified element at the specified position in this list.
void	clearFilters() Removes all of the elements from this list.
Set<org.apache.maven.artifact.Artifact>	filter(Set<org.apache.maven.artifact.Artifact> artifacts) filter.
List<ArtifactsFilter>	getFilters() Getter for the field filters.
void	setFilters(List<ArtifactsFilter> filters) Setter for the field filters.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterArtifacts

public FilterArtifacts()

Created new instance.

Method Detail

clearFilters

public void clearFilters()

Removes all of the elements from this list. The list will be empty after this call returns.

addFilter

public void addFilter(ArtifactsFilter filter)

Appends the specified element to the end of this list.

Parameters:

filter - element to be appended to this list.

addFilter

public void addFilter(int index,
                      ArtifactsFilter filter)

Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters:

index - at which index the specified filter is to be inserted.

filter - the filter to be inserted.

Throws:

IndexOutOfBoundsException - if index is out of range (index < 0 || index > size()).

filter

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

filter.

Parameters:

artifacts - The Artifacts to filter.

Returns:

The resulting artifacts set.

Throws:

ArtifactFilterException - in case of a failure.

getFilters

public List<ArtifactsFilter> getFilters()

Getter for the field filters.

Returns:

the filters.

setFilters

public void setFilters(List<ArtifactsFilter> filters)

Setter for the field filters.

Parameters:

filters - The filters to set.