AncestorOrSelfDependencyNodeFilter

java.lang.Object

org.apache.maven.shared.dependency.graph.filter.AncestorOrSelfDependencyNodeFilter

All Implemented Interfaces:: DependencyNodeFilter

public class AncestorOrSelfDependencyNodeFilter extends 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$

Field Summary

Fields

Modifier and Type

Field

Description

private final List<DependencyNode>

descendantNodes

The list of nodes that this filter accepts ancestors-or-self of.
Constructor Summary

Constructors

Constructor

Description

AncestorOrSelfDependencyNodeFilter(List<DependencyNode> descendantNodes)

Creates a dependency node filter that only accepts nodes that are ancestors of, or equal to, the specified list of nodes.

AncestorOrSelfDependencyNodeFilter(DependencyNode descendantNode)
Method Summary

Modifier and Type

Method

Description

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 Details
- descendantNodes
  
  private final List<DependencyNode> descendantNodes
  
  The list of nodes that this filter accepts ancestors-or-self of.
Constructor Details
- AncestorOrSelfDependencyNodeFilter
  
  public AncestorOrSelfDependencyNodeFilter(DependencyNode descendantNode)
- AncestorOrSelfDependencyNodeFilter
  
  public AncestorOrSelfDependencyNodeFilter(List<DependencyNode> 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 Details
- accept
  
  public boolean accept(DependencyNode node)
  
  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