com.ergotech.secs

Class SecsEventHandler

java.lang.Object

com.ergotech.secs.SecsEventHandler

All Implemented Interfaces:

SecsEventListener, java.util.EventListener

public class SecsEventHandler
extends java.lang.Object
implements SecsEventListener

This object will handle all events posted to it.

Field Summary

Fields

Modifier and Type	Field and Description
static SecsEventHandler	defaultHandler This is the default handler used on this machine.

Fields inherited from interface com.ergotech.secs.SecsEventListener

cvsRev

Constructor Summary

Constructors

Constructor and Description
SecsEventHandler()

Method Summary

Modifier and Type	Method and Description
void	addListener(SecsEventListener newListener) This will register the listener for ALL events.
void	addListenerForId(SecsEventListener newListener, int theEventId) This will register a SecsEventListeners to receive a specific event by id.
static void	defaultAddListenerForId(SecsEventListener newListener, int theEventId) This will register a SecsEventListeners to receive a specific event by id.
static void	defaultRemoveListenerForId(SecsEventListener newListener) This will unregister a SecsEventListeners from all events.
static void	defaultRemoveListenerForId(SecsEventListener newListener, int theEventId) This will unregister a SecsEventListeners to receive a specific event by id.
static SecsEventHandler	getDefaultHandler() This will return the default handler for this machine.
void	post(SecsEvent theEvent) This will take a new event, and notify all listeners before returning.
void	removeListener(SecsEventListener newListener) This will remove all range of events that this listener was receiving.
void	removeListenerForId(SecsEventListener newListener, int theEventId) This will remove a eventID that this listener was receiving.
void	secsEvent(SecsEvent theEvent) This is usually called by another SecsEventHandler.
java.lang.String	toString() Try to make the SecsEventHandlers display be a little more human readable.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

defaultHandler

public static SecsEventHandler defaultHandler

This is the default handler used on this machine.

Constructor Detail

SecsEventHandler

public SecsEventHandler()

Method Detail

addListener

public void addListener(SecsEventListener newListener)

This will register the listener for ALL events. This will also remove all ranges already specified. You must unregister with the removeSecsEventListener method. Removing a sub-range is not allowed when you receive all events.

See Also:

removeListener(com.ergotech.secs.SecsEventListener)

addListenerForId

public void addListenerForId(SecsEventListener newListener,
                             int theEventId)

This will register a SecsEventListeners to receive a specific event by id.

defaultAddListenerForId

public static void defaultAddListenerForId(SecsEventListener newListener,
                                           int theEventId)

This will register a SecsEventListeners to receive a specific event by id.

defaultRemoveListenerForId

public static void defaultRemoveListenerForId(SecsEventListener newListener)

This will unregister a SecsEventListeners from all events.

defaultRemoveListenerForId

public static void defaultRemoveListenerForId(SecsEventListener newListener,
                                              int theEventId)

This will unregister a SecsEventListeners to receive a specific event by id.

getDefaultHandler

public static SecsEventHandler getDefaultHandler()

This will return the default handler for this machine.

post

public void post(SecsEvent theEvent)

This will take a new event, and notify all listeners before returning. This may cause a lockup or slowdown if the listener takes any time before continuing.

removeListener

public void removeListener(SecsEventListener newListener)

This will remove all range of events that this listener was receiving.

See Also:

addListener(com.ergotech.secs.SecsEventListener)

removeListenerForId

public void removeListenerForId(SecsEventListener newListener,
                                int theEventId)

This will remove a eventID that this listener was receiving.

secsEvent

public void secsEvent(SecsEvent theEvent)

This is usually called by another SecsEventHandler. This should then pass the event on as if it was posted directly to us. This is here to support events from other hosts.

Specified by:

secsEvent in interface SecsEventListener

toString

public java.lang.String toString()

Try to make the SecsEventHandlers display be a little more human readable. This can be a long string.

Overrides:

toString in class java.lang.Object