apps.pathfinder
Class SinkCapsule

java.lang.Object
  |
  +--bees.core.Packet
        |
        +--bees.core.ANEPPacket
              |
              +--bees.core.Capsule
                    |
                    +--apps.pathfinder.SinkCapsule

Direct Known Subclasses:

NodeHealthCapsule

public abstract class SinkCapsule

extends Capsule

A SinkCapsule is a base class for Capsule types that originate at the leafs of the pathfinder tree and are directed toward the root.

Constructor Summary

SinkCapsule()
Construct an empty SinkCapsule object.

Method Summary

boolean	evaluate(Node node, PathfinderSession pfs) Evaluate a Capsule and possibly forward it toward the root.
java.lang.String	toString()

Methods inherited from class bees.core.Capsule

addToPool, checkPermission, clone, decode, decodingException, encode, equals, evaluate, evaluate, fromCapsule, fromExternal, getCapsuleID, getFlowDesc, getSession, getSession, getSource, internalDecode, internalEncode, internalReset, reset, skipOptions, specializeCapsule

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SinkCapsule

public SinkCapsule()

Construct an empty SinkCapsule object.

Method Detail

evaluate

public boolean evaluate(Node node,
                        PathfinderSession pfs)

Evaluate a Capsule and possibly forward it toward the root.

Parameters:

node - The current Node object.

pfs - The PathfinderSession this capsule belongs to.

Returns:

True if this is the root and the Capsule should be processed or false if this is an intermediate node.

toString

public java.lang.String toString()

Overrides:

toString in class Capsule

See Also:

Object.toString()