gumbo.util.route
Class NotifyNode

java.lang.Object
  |
  +--gumbo.util.AbstractDisposable
        |
        +--gumbo.util.route.EventNode
              |
              +--gumbo.util.route.EventDataNode
                    |
                    +--gumbo.util.route.NotifyNode

All Implemented Interfaces:

Disposable, EventNodeMarker

Direct Known Subclasses:

NotifyNode.EventIn, NotifyNode.EventInOut, NotifyNode.EventOut

public class NotifyNode

extends EventDataNode

An event data node that transfers no data (event is for notification only). As such, this node can receive an event from any other data node.

Version:

$Revision: 1.2 $

Author:

Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Nested Class Summary

static class	NotifyNode.EventIn
static class	NotifyNode.EventInOut
static class	NotifyNode.EventOut

Constructor Summary

NotifyNode()

Method Summary

protected void	checkSender(EventDataNode sender) Called by the system (subclasses) to check a sender before connecting it to this node.
protected java.lang.String	getDataValue() Get this node's data value as a string.
boolean	set() Equivalent to receiving an event.

Methods inherited from class gumbo.util.route.EventDataNode

checkRouter, enableDebug, getReceivers, getRelayType, getSenders, implDispose, implSend, implSysProcess, isReceiver, isSender, process, setDebug, setDebug, setRelayType, sync

Methods inherited from class gumbo.util.route.EventNode

isLocked

Methods inherited from class gumbo.util.AbstractDisposable

dispose, isDisposed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotifyNode

public NotifyNode()

Method Detail

set

public final boolean set()

Equivalent to receiving an event. Processes the event and, if enabled, relays the event to receivers.

getDataValue

protected java.lang.String getDataValue()

Description copied from class: EventDataNode

Get this node's data value as a string. Used by the system to contruct a debug message.

Specified by:

getDataValue in class EventDataNode

Returns:

The data value. Empty if no value (NotifyNode). Never null.

checkSender

protected void checkSender(EventDataNode sender)

Description copied from class: EventDataNode

Called by the system (subclasses) to check a sender before connecting it to this node. Implementers should throw an exception if the sender is invalid, and can assume that the sender is non-null.

Specified by:

checkSender in class EventDataNode