org.apache.maven.shared.dependency.tree.filter
Class AncestorOrSelfDependencyNodeFilter

java.lang.Object
  extended by org.apache.maven.shared.dependency.tree.filter.AncestorOrSelfDependencyNodeFilter
All Implemented Interfaces:
DependencyNodeFilter

public class AncestorOrSelfDependencyNodeFilter
extends java.lang.Object
implements DependencyNodeFilter

A dependency node filter than only accepts nodes that are ancestors of, or equal to, a given list of nodes.

Since:
1.1
Version:
$Id: AncestorOrSelfDependencyNodeFilter.java 549521 2007-06-21 15:53:42Z markh $
Author:
Mark Hobson

Field Summary
private  java.util.List descendantNodes
          The list of nodes that this filter accepts ancestors-or-self of.
 
Constructor Summary
AncestorOrSelfDependencyNodeFilter(DependencyNode descendantNode)
           
AncestorOrSelfDependencyNodeFilter(java.util.List descendantNodes)
          Creates a dependency node filter that only accepts nodes that are ancestors of, or equal to, the specified list of nodes.
 
Method Summary
 boolean accept(DependencyNode node)
          Gets whether this filter accepts the specified dependency node.
private  boolean isAncestorOrSelf(DependencyNode ancestorNode, DependencyNode descendantNode)
          Gets whether the first dependency node is an ancestor-or-self of the second.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

descendantNodes

private final java.util.List descendantNodes
The list of nodes that this filter accepts ancestors-or-self of.

Constructor Detail

AncestorOrSelfDependencyNodeFilter

public AncestorOrSelfDependencyNodeFilter(DependencyNode descendantNode)

AncestorOrSelfDependencyNodeFilter

public AncestorOrSelfDependencyNodeFilter(java.util.List descendantNodes)
Creates a dependency node filter that only accepts nodes that are ancestors of, or equal to, the specified list of nodes.

Parameters:
descendantNodes - the list of nodes to accept ancestors-or-self of
Method Detail

accept

public boolean accept(DependencyNode node)
Description copied from interface: DependencyNodeFilter
Gets whether this filter accepts the specified dependency node.

Specified by:
accept in interface DependencyNodeFilter
Parameters:
node - the dependency node to check
Returns:
true if this filter accepts the specified dependency node

isAncestorOrSelf

private boolean isAncestorOrSelf(DependencyNode ancestorNode,
                                 DependencyNode descendantNode)
Gets whether the first dependency node is an ancestor-or-self of the second.

Parameters:
ancestorNode - the ancestor-or-self dependency node
descendantNode - the dependency node to test
Returns:
true if ancestorNode is an ancestor, or equal to, descendantNode