com.phoenixst.plexus
Interface EdgePredicate

All Superinterfaces:

org.apache.commons.collections.Predicate

public interface EdgePredicate
extends org.apache.commons.collections.Predicate

A general interface for Predicates testing Graph.Edges that can be piecewise defined. These objects can be used by:

• Graph.edges( Predicate )
• Graph.getEdge( Predicate )

Since:

1.0

Version:

$Revision: 1.3 $

Author:

Ray A. Conner

Method Summary

boolean	evaluate(Object object) Returns true if the specified object satisfies this EdgePredicate, and false otherwise.
int	getDirectionFlags() Gets the direction flags for this EdgePredicate relative to the first node specification.
Object	getFirstNodeSpecification() Gets the first node specification for this EdgePredicate.
Object	getSecondNodeSpecification() Gets the second node specification for this EdgePredicate.
Object	getUserObjectSpecification() Gets the user object specification for this EdgePredicate.

Method Detail

evaluate

boolean evaluate(Object object)

Returns true if the specified object satisfies this EdgePredicate, and false otherwise. The specified object is expected to be an instance of Graph.Edge.

Specified by:

evaluate in interface org.apache.commons.collections.Predicate

getUserObjectSpecification

Object getUserObjectSpecification()

Gets the user object specification for this EdgePredicate.

If the returned object is a Predicate, then that Predicate must evaluate to true when testing the contained user object for this EdgePredicate to be true.

If the returned object is anything other than a Predicate, then the contained user object must be .equals() to the specified object (or it must be null if the specified object is null) for this EdgePredicate to be true.

getFirstNodeSpecification

Object getFirstNodeSpecification()

Gets the first node specification for this EdgePredicate.

If the returned object is a Predicate, then that Predicate must evaluate to true when testing the first node for this EdgePredicate to be true.

If the returned object is anything other than a Predicate, then the first node must be .equals() to the specified object (or it must be null if the specified object is null) for this EdgePredicate to be true.

getSecondNodeSpecification

Object getSecondNodeSpecification()

Gets the second node specification for this EdgePredicate.

If the returned object is a Predicate, then that Predicate must evaluate to true when testing the second node for this EdgePredicate to be true.

If the returned object is anything other than a Predicate, then the second node must be .equals() to the specified object (or it must be null if the specified object is null) for this EdgePredicate to be true.

getDirectionFlags

int getDirectionFlags()

Gets the direction flags for this EdgePredicate relative to the first node specification. It may be any of the following values, or some combination made using bitwise-or:

• GraphUtils.UNDIRECTED_MASK
• GraphUtils.DIRECTED_OUT_MASK
• GraphUtils.DIRECTED_IN_MASK
• GraphUtils.DIRECTED_MASK
• GraphUtils.ANY_DIRECTION_MASK