org.eclipse.soda.dk.command
Class CommandListeners

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.command.CommandListeners

All Implemented Interfaces:

CommandListener, ErrorListener

public class CommandListeners
extends EscObject
implements CommandListener

The CommandListeners class implements the CommandListener interface.

Version:

1.0.0

See Also:

ErrorListener, CommandListener

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

Constructor Summary

CommandListeners(CommandListener[] objects)
Constructs an CommandListeners object using the input parameter(s).

CommandListeners(CommandListener currentObject, CommandListener newObject)
Constructs an CommandListeners object using the input parameter(s).

Method Summary

static CommandListener	add(CommandListener currentObject, CommandListener newObject) Perform the add method and return the CommandListener result.
void	commandExecuted(CommandService source, java.lang.Object timestamp, java.lang.Object data) This method is fired to all Listeners each time the command is executed.
void	errorOccurred(java.lang.Object source, java.lang.Object timestamp, java.lang.Object data) The errorOccurred method is called when an error has occurred.
CommandListener[]	getObjects() Gets the CommandListener [] objects property value.
protected CommandListener	remove(CommandListener removeHandler) Perform the remove method and return the CommandListener result.
static CommandListener	remove(CommandListener currentObject, CommandListener removeObject) Perform the remove method and return the CommandListener 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

CommandListeners

public CommandListeners(CommandListener[] objects)

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

Parameters:

objects - CommandListener[]

See Also:

CommandListeners(CommandListener,CommandListener)

CommandListeners

public CommandListeners(CommandListener currentObject,
                        CommandListener newObject)

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

Parameters:

currentObject - CommandListener

newObject - CommandListener

See Also:

CommandListeners(CommandListener[])

Method Detail

add

public static CommandListener add(CommandListener currentObject,
                                  CommandListener newObject)

Perform the add method and return the CommandListener result.

Parameters:

currentObject - CommandListener

newObject - CommandListener

Returns:

Results of the add (CommandListener) value.

remove

public static CommandListener remove(CommandListener currentObject,
                                     CommandListener removeObject)

Perform the remove method and return the CommandListener result.

Parameters:

currentObject - CommandListener

removeObject - CommandListener

Returns:

Results of the remove (CommandListener) value.

See Also:

remove(CommandListener)

commandExecuted

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

This method is fired to all Listeners each time the command is executed. 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:

commandExecuted in interface CommandListener

Parameters:

source - CommandService which was executed.

timestamp - The time at which the command execution was detected.

data - Any data which was contained within the command.

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 CommandListener[] getObjects()

Gets the CommandListener [] objects property value.

Returns:

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

remove

protected CommandListener remove(CommandListener removeHandler)

Perform the remove method and return the CommandListener result.

Parameters:

removeHandler - CommandListener

Returns:

Results of the remove (CommandListener) value.

See Also:

remove(CommandListener,CommandListener)