rcf.core.concurrent.events
Interface EventSink<E extends Event>

Type Parameters:

E - The type of events this syndicate is looking to receive. The runtime value of this type parameter should be specified in any calls to EventSyndicate.add(rcf.core.util.reference.Reference, Class).

All Known Subinterfaces:

EventSyndicate

All Known Implementing Classes:

AbstractDynamicProperty.BooleanUpdate, AbstractDynamicProperty.DoubleUpdate, AbstractDynamicProperty.EnumComboUpdate, AbstractDynamicProperty.EnumRadioUpdate, AbstractDynamicProperty.IntegerUpdate, AbstractDynamicProperty.StringUpdate, AbstractNetworkTunnel.SessionStateProxy, AbstractRADService.StateProxy, ArrayEventSyndicate, DefaultDynamicProperty.IdentityChangeEventSink, DynamicProperty.Default.IdentityChangeEventSink, DynamicProperty.Default.IdentityChangeEventSink.TaskEventSink, Framework.Default.ServiceTaskEventSink, GUICollection.GUICollectionEventSink, GUICollection.GUICollectionEventSink.TaskEventSink, GUIHelpers.WindowCloserFrameworkEventSink, GUITree.GUITreeEventSink, GUITree.GUITreeEventSink.TaskEventSink, HAProxyLinux.GeneralSink, HAProxyLinux.GeneralSink.PoolsTaskEventSink, HAProxyLinux.GeneralSink.ServersTaskEventSink, HashEventSyndicate, LigHTTPDLinux.ConfigSink, LinuxSystem.FrameworkEventSink, MySQLFedora.ConfigSink, RADTools, RoRServerLinux.DatabaseSink, RoRServerLinux.EnvironmentSink

@Revision(value="$Revision: 1.6 $",
          date="$Date: 2006/12/15 20:37:49 $",
          tag="$Name:  $")
public interface EventSink<E extends Event>

A sink for Events which can be registered with syndicates through the EventSyndicate.add(rcf.core.util.reference.Reference, Class) method. For more information about the event model, see rcf.core.concurrent.events.

TODO: Javadoc review, Seal/Finalize

Version:

$Revision: 1.6 $

Author:

Greg Gibeling

Method Summary

boolean

event(E event) Called by an EventSyndicate to notify this sink that an event has occured.

Method Detail

event

boolean event(E event)

Called by an EventSyndicate to notify this sink that an event has occured.

Parameters:

event - The event which has occured.

Returns:

true to keep receiving events from the source of this event. false to stop receiving events from the source of this event.