org.eclipse.soda.dk.device
Class DeviceListeners

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.DeviceListeners

All Implemented Interfaces:

DeviceListener, ErrorListener

public class DeviceListeners
extends EscObject
implements DeviceListener

The DeviceListeners class implements the DeviceListener interface.

Version:

1.0.0

See Also:

ErrorListener, DeviceListener

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, INTEGER_TABLE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, 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

Fields inherited from interface org.eclipse.soda.dk.device.service.DeviceListener

ADDED, CHANGED, REMOVED

Constructor Summary

DeviceListeners(DeviceListener[] objects)
Constructs an DeviceListeners object using the input parameter(s).

DeviceListeners(DeviceListener currentObject, DeviceListener newObject)
Constructs an DeviceListeners object using the input parameter(s).

Method Summary

static DeviceListener	add(DeviceListener currentObject, DeviceListener newObject) Perform the add method and return the DeviceListener result.
void	controlChanged(DeviceService container, java.lang.Object timestamp, ControlService control, int code) The controlChanged method is called when a control was changed.
void	deviceChanged(DeviceService source, java.lang.Object timestamp, int newState, int oldState) This method will be called when the state of the DeviceService changes.
void	errorOccurred(java.lang.Object source, java.lang.Object timestamp, java.lang.Object data) The errorOccurred method is called when an error has occurred.
DeviceListener[]	getObjects() Gets the DeviceListener [] objects property value.
protected DeviceListener	remove(DeviceListener removeHandler) Perform the remove method and return the DeviceListener result.
static DeviceListener	remove(DeviceListener currentObject, DeviceListener removeObject) Perform the remove method and return the Object result.

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

attemptRecoveryFromError, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getErrorSeverity, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getResource, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, 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

DeviceListeners

public DeviceListeners(DeviceListener[] objects)

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

Parameters:

objects - DeviceListener[]

See Also:

DeviceListeners(DeviceListener,DeviceListener)

DeviceListeners

public DeviceListeners(DeviceListener currentObject,
                       DeviceListener newObject)

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

Parameters:

currentObject - DeviceListener

newObject - DeviceListener

See Also:

DeviceListeners(DeviceListener[])

Method Detail

add

public static DeviceListener add(DeviceListener currentObject,
                                 DeviceListener newObject)

Perform the add method and return the DeviceListener result.

Parameters:

currentObject - DeviceListener

newObject - DeviceListener

Returns:

Results of the add (DeviceListener) value.

remove

public static DeviceListener remove(DeviceListener currentObject,
                                    DeviceListener removeObject)

Perform the remove method and return the Object result.

Parameters:

currentObject - DeviceListener

removeObject - DeviceListener

Returns:

Results of the remove (DeviceListener) value.

See Also:

remove(DeviceListener)

controlChanged

public void controlChanged(DeviceService container,
                           java.lang.Object timestamp,
                           ControlService control,
                           int code)

The controlChanged method is called when a control was changed. A notification method to all DeviceListeners that a ControlService, specified by the control argument, and contained within the DeviceService, specified in the device arguement, was Added, Removed, or Modified, specified by the code argument in accordance with the above constants, at the time specified by the timestamp argument. In English : A control of the DeviceService was changed in the following manner at this time. Since other notifications are blocked until this method returns, implementors of this method should:

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

Specified by:

controlChanged in interface DeviceListener

Parameters:

container - org.eclipse.soda.dk.device.service.DeviceService

timestamp - java.lang.Object

control - org.eclipse.soda.dk.device.service.ControlService

code - int

See Also:

deviceChanged(DeviceService,Object,int,int)

deviceChanged

public void deviceChanged(DeviceService source,
                          java.lang.Object timestamp,
                          int newState,
                          int oldState)

This method will be called when the state of the DeviceService changes. Since other notifications are blocked until this method returns, implementors of this method should:

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

Because of the multiple threads and quickly changing states, the current state of the device may not be the same as the newState input parameter.

Specified by:

deviceChanged in interface DeviceListener

Parameters:

source - org.eclipse.soda.dk.device.service.DeviceService

timestamp - java.lang.Object

newState - The new state of the DeviceService when the notification process started.

oldState - The old state of the DeviceService.

See Also:

controlChanged(DeviceService,Object,ControlService,int)

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 (eg calling read on a measuremnt).
• Handle this call quickly and return.

Specified by:

errorOccurred in interface ErrorListener

Parameters:

source - The source object that detected the error.

timestamp - The time at which the error was detected.

data - Contains any data about the error.

getObjects

public DeviceListener[] getObjects()

Gets the DeviceListener [] objects property value.

Returns:

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

remove

protected DeviceListener remove(DeviceListener removeHandler)

Perform the remove method and return the DeviceListener result.

Parameters:

removeHandler - DeviceListener

Returns:

Results of the remove (DeviceListener) value.

See Also:

remove(DeviceListener,DeviceListener)