org.sonatype.aether.util.filter
Class ScopeDependencyFilter

java.lang.Object
  extended by org.sonatype.aether.util.filter.ScopeDependencyFilter
All Implemented Interfaces:
DependencyFilter

public class ScopeDependencyFilter
extends java.lang.Object
implements DependencyFilter

A dependency filter based on dependency scopes. Note: This filter does not assume any relationships between the scopes. In particular, the filter is not aware of scopes that logically include other scopes.

Author:
Benjamin Bentmann
See Also:
Dependency.getScope()

Constructor Summary
ScopeDependencyFilter(java.util.Collection<java.lang.String> included, java.util.Collection<java.lang.String> excluded)
          Creates a new filter using the specified includes and excludes.
ScopeDependencyFilter(java.lang.String... excluded)
          Creates a new filter using the specified excludes.
 
Method Summary
 boolean accept(DependencyNode node, java.util.List<DependencyNode> parents)
          Indicates whether the specified dependency node shall be included or excluded.
 boolean equals(java.lang.Object obj)
           
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScopeDependencyFilter

public ScopeDependencyFilter(java.util.Collection<java.lang.String> included,
                             java.util.Collection<java.lang.String> excluded)
Creates a new filter using the specified includes and excludes.

Parameters:
included - The set of scopes to include, may be null or empty to include any scope.
excluded - The set of scopes to exclude, may be null or empty to exclude no scope.

ScopeDependencyFilter

public ScopeDependencyFilter(java.lang.String... excluded)
Creates a new filter using the specified excludes.

Parameters:
excluded - The set of scopes to exclude, may be null or empty to exclude no scope.
Method Detail

accept

public boolean accept(DependencyNode node,
                      java.util.List<DependencyNode> parents)
Description copied from interface: DependencyFilter
Indicates whether the specified dependency node shall be included or excluded.

Specified by:
accept in interface DependencyFilter
Parameters:
node - The dependency node to filter, must not be null.
parents - The (read-only) chain of parent nodes that leads to the node to be filtered, must not be null. Iterating this (possibly empty) list walks up the dependency graph towards the root node, i.e. the immediate parent node (if any) is the first node in the list. The size of the list also denotes the zero-based depth of the filtered node.
Returns:
true to include the dependency node, false to exclude it.

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2010-2011 Sonatype, Inc.. All Rights Reserved.