IncidentEdgeCollection (Plexus v0.13.1 API Specification)

Class IncidentEdgeCollection

public class IncidentEdgeCollection extends AbstractCollection

A Collection for Graph.Edges to help implement the

Graph.incidentEdges(
  Predicate )

method.

Since: 1.0

Version: $Revision: 1.7 $

Author: Ray A. Conner

Constructor Summary
	IncidentEdgeCollection(Graph graph, Object baseNode, Predicate traverserPredicate) Creates a new `IncidentEdgeCollection`.

Constructor Summary

IncidentEdgeCollection(Graph graph, Object baseNode, Predicate traverserPredicate)

Creates a new IncidentEdgeCollection.

Method Summary
boolean	addAll(Collection collection) Throws an `UnsupportedOperationException`.
boolean	contains(Object object) This implementation delegates to `Graph.containsEdge( Object )` if the specified object passes the `Predicate` specified by the constructor and is incident upon the `baseNode`.
Iterator	iterator() This implementation returns a wrapper around `Graph.traverser( node, predicate )`.
boolean	remove(Object object) This implementation delegates to `Graph.removeEdge( Object )` if the specified object passes the `Predicate` specified by the constructor and is incident upon the `baseNode`.
int	size() This implementation delegates to `Graph.degree( node, predicate )`.

Method Summary

boolean

addAll(Collection collection)

Throws an UnsupportedOperationException.

boolean

contains(Object object)

This implementation delegates to Graph.containsEdge( Object ) if the specified object passes the Predicate specified by the constructor and is incident upon the baseNode.

Iterator

iterator()

This implementation returns a wrapper around

 Graph.traverser( node,
  predicate )

boolean

remove(Object object)

This implementation delegates to Graph.removeEdge( Object ) if the specified object passes the Predicate specified by the constructor and is incident upon the baseNode.

int

size()

This implementation delegates to

 Graph.degree( node, predicate
  )

Constructor Detail

IncidentEdgeCollection

Creates a new IncidentEdgeCollection. If a null Predicate is passed to this constructor, TruePredicate is used internally.

Method Detail

addAll

Throws an UnsupportedOperationException.

contains

This implementation delegates to Graph.containsEdge( Object ) if the specified object passes the Predicate specified by the constructor and is incident upon the baseNode.

iterator

This implementation returns a wrapper around

 Graph.traverser( node,
  predicate )

remove

This implementation delegates to Graph.removeEdge( Object ) if the specified object passes the Predicate specified by the constructor and is incident upon the baseNode.

size

This implementation delegates to

 Graph.degree( node, predicate
  )