EventReceiver

java.lang.Object

net.i2p.i2ptunnel.irc.EventReceiver

All Implemented Interfaces:: EventDispatcher

Direct Known Subclasses:: DCCClientManager

public abstract class EventReceiverextends Object implements EventDispatcher

An implementation of the EventDispatcher interface for receiving events via in-line notifyEvent(String, Object) only. Does not support chaining to additional dispatchers. Does not support waitEventValue(String). Does not support ignoring.

Constructor Summary
Constructors
Constructor
Description
EventReceiver()
Constructor for subclasses that receive events through notifyEvent().
Method Summary
Modifier and Type
Method
Description
void
attachEventDispatcher(EventDispatcher ev)
Subscribe to IRC events.
void
detachEventDispatcher(EventDispatcher ev)
Unsubscribe from IRC events.
EventDispatcher
getEventDispatcher()
Object to be used to deliver events (usually this, but YMMV).
Set<String>
getEvents()
All registered event names.
Object
getEventValue(String name)
Value of the last fired event.
void
ignoreEvents()
Stop waiting for events.
abstract void
notifyEvent(String eventName, Object args)
Deliver an event.
void
unIgnoreEvents()
Almost like the method above :-).
Object
waitEventValue(String name)
Block until the event fires and return its value.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- EventReceiver
  public EventReceiver()
  Constructor for subclasses that receive events through notifyEvent().
Method Details
- getEventDispatcher
  public EventDispatcher getEventDispatcher()
  Description copied from interface: EventDispatcher
  Object to be used to deliver events (usually this, but YMMV).
  Specified by:
  getEventDispatcher in interface EventDispatcher
  Returns:
  the event dispatcher
- attachEventDispatcher
  public void attachEventDispatcher(EventDispatcher ev)
  Subscribe to IRC events.
  Specified by:
  attachEventDispatcher in interface EventDispatcher
  Parameters:
  ev - Event object to be attached
  Throws:
  UnsupportedOperationException - always; the receiver is its own dispatcher
- detachEventDispatcher
  public void detachEventDispatcher(EventDispatcher ev)
  Unsubscribe from IRC events.
  Specified by:
  detachEventDispatcher in interface EventDispatcher
  Parameters:
  ev - Event object to be detached
  Throws:
  UnsupportedOperationException - always; the receiver is its own dispatcher
- notifyEvent
  public abstract void notifyEvent(String eventName, Object args)
  Description copied from interface: EventDispatcher
  Deliver an event.
  Specified by:
  notifyEvent in interface EventDispatcher
  Parameters:
  eventName - name of the event
  args - data being stored for that event
- getEventValue
  public Object getEventValue(String name)
  Value of the last fired event.
  Specified by:
  getEventValue in interface EventDispatcher
  Parameters:
  name - name of the event to query for
  Returns:
  never returns, as a receiver stores no event values
  Throws:
  UnsupportedOperationException - always; a receiver stores no event values
- getEvents
  public Set<String> getEvents()
  All registered event names.
  Specified by:
  getEvents in interface EventDispatcher
  Returns:
  never returns, as the receiver registers no event names
  Throws:
  UnsupportedOperationException - always; the registry is never populated
- ignoreEvents
  public void ignoreEvents()
  Stop waiting for events.
  Specified by:
  ignoreEvents in interface EventDispatcher
  Throws:
  UnsupportedOperationException - always; there is nothing to ignore
- unIgnoreEvents
  public void unIgnoreEvents()
  Description copied from interface: EventDispatcher
  Almost like the method above :-).
  Specified by:
  unIgnoreEvents in interface EventDispatcher
- waitEventValue
  public Object waitEventValue(String name)
  Block until the event fires and return its value.
  Specified by:
  waitEventValue in interface EventDispatcher
  Parameters:
  name - name of the event to wait for
  Returns:
  value specified for that event
  Throws:
  UnsupportedOperationException - always; a receiver cannot block on an event

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Details

Method Details

getEventDispatcher

attachEventDispatcher

detachEventDispatcher

notifyEvent

getEventValue

getEvents

ignoreEvents

unIgnoreEvents

waitEventValue