org.eclipse.soda.dk.signal
Class SignalListeners

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.signal.SignalListeners

All Implemented Interfaces:

MultiplexSignalListener, SignalListener, ErrorListener

public class SignalListeners
extends EscObject
implements MultiplexSignalListener

The SignalListeners class implements the SignalListener interface.

Since:

1.0

Version:

1.2.0

See Also:

ErrorListener, SignalListener

Field Summary

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, ID_NAME_KEY, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_DEFAULT, LOG_ERROR, LOG_INFO, LOG_LEVEL_KEY, LOG_TRACE, LOG_WARNING, LONG_TABLE, LONG_TABLE_SIZE, PREFIX_KEY, READONLY_EMPTY_COLLECTION, READONLY_EMPTY_LIST, READONLY_EMPTY_MAP, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE, Unmodifiable

Constructor Summary

SignalListeners(SignalListener[] objects)
Constructs an SignalListeners object using the input parameter(s).

SignalListeners(SignalListener currentObject, SignalListener newObject)
Constructs an SignalListeners object using the input parameter(s).

Method Summary

static SignalListener	add(SignalListener currentObject, SignalListener newObject) Perform the add method and return the SignalListener result.
void	errorOccurred(java.lang.Object source, java.lang.Object timestamp, java.lang.Object data) The errorOccurred method is called when an error has occurred.
SignalListener[]	getObjects() Gets the SignalListener[] objects property value.
protected SignalListener	remove(SignalListener removeHandler) Perform the remove method and return the SignalListener result.
static SignalListener	remove(SignalListener currentObject, SignalListener removeObject) Perform the remove method and return the SignalListener result.
void	signalOccurred(SignalService source, java.lang.Object timestamp, ChannelService channel, java.lang.Object data) Signal occurred with the specified source, timestamp, channel and data parameters.
void	signalOccurred(SignalService source, java.lang.Object timestamp, java.lang.Object data) This method is fired to all Listeners each time the signal triggered.

Methods inherited from class org.eclipse.soda.dk.core.EscObject

attemptRecoveryFromError, createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getErrorSeverity, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogLevel, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getResource, getShort, getSimpleClassName, getStaticBoolean, getStaticByte, getStaticChar, getStaticDouble, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticShort, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isBackward, isDebug, isLogging, isTrace, isUnmodifiable, loadService, log, log, log, report, report, report, report, report, report, report, reportError, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

SignalListeners

public SignalListeners(SignalListener currentObject,
                       SignalListener newObject)

Constructs an SignalListeners object using the input parameter(s).

Parameters:

currentObject - The current object (SignalListener) parameter.

newObject - The new object (SignalListener) parameter.

See Also:

SignalListeners(SignalListener[])

SignalListeners

public SignalListeners(SignalListener[] objects)

Constructs an SignalListeners object using the input parameter(s).

Parameters:

objects - The objects (SignalListener[]) parameter.

See Also:

SignalListeners(SignalListener,SignalListener)

Method Detail

add

public static SignalListener add(SignalListener currentObject,
                                 SignalListener newObject)

Perform the add method and return the SignalListener result.

Parameters:

currentObject - The current object (SignalListener) parameter.

newObject - The new object (SignalListener) parameter.

Returns:

Results of the add (SignalListener) value.

remove

public static SignalListener remove(SignalListener currentObject,
                                    SignalListener removeObject)

Perform the remove method and return the SignalListener result.

Parameters:

currentObject - The current object (SignalListener) parameter.

removeObject - The remove object (SignalListener) parameter.

Returns:

Results of the remove (SignalListener) value.

See Also:

remove(SignalListener)

errorOccurred

public void errorOccurred(java.lang.Object source,
                          java.lang.Object timestamp,
                          java.lang.Object data)

The errorOccurred method is called when an error has occurred. Since other notifications are blocked until this method returns, implementors of this method should:

• Not cause the device or transport to be blocked (e.g. calling read on a measurement).
• Handle this call quickly and return.

Specified by:

errorOccurred in interface ErrorListener

Parameters:

source - The source (Object) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

See Also:

signalOccurred(SignalService,Object,ChannelService,Object), signalOccurred(SignalService,Object,Object)

getObjects

public SignalListener[] getObjects()

Gets the SignalListener[] objects property value.

Returns:

Results of the get objects (SignalListener[]) value.

remove

protected SignalListener remove(SignalListener removeHandler)

Perform the remove method and return the SignalListener result.

Parameters:

removeHandler - The remove handler (SignalListener) parameter.

Returns:

Results of the remove (SignalListener) value.

See Also:

remove(SignalListener,SignalListener)

signalOccurred

public void signalOccurred(SignalService source,
                           java.lang.Object timestamp,
                           ChannelService channel,
                           java.lang.Object data)

Signal occurred with the specified source, timestamp, channel and data parameters.

Specified by:

signalOccurred in interface MultiplexSignalListener

Parameters:

source - The source (SignalService) parameter.

timestamp - The time stamp (Object) parameter.

channel - The channel (ChannelService) parameter.

data - The data (Object) parameter.

Since:

1.2

See Also:

errorOccurred(Object,Object,Object), signalOccurred(SignalService,Object,Object)

signalOccurred

public void signalOccurred(SignalService source,
                           java.lang.Object timestamp,
                           java.lang.Object data)

This method is fired to all Listeners each time the signal triggered. The signal can be triggered when a message is received from the hardware or when the trigger method is invoked by the application. Since other notifications are blocked until this method returns, implementors of this method should:

• Not cause the device or transport to be blocked (e.g. calling read on a measurement).
• Handle this call quickly and return.

Specified by:

signalOccurred in interface SignalListener

Parameters:

source - The source (SignalService) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

See Also:

errorOccurred(Object,Object,Object), signalOccurred(SignalService,Object,ChannelService,Object)