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, MultiplexCommandListener, ErrorListener

public class CommandListeners
extends EscObject
implements MultiplexCommandListener

The CommandListeners class implements the CommandListener interface.

Since:

1.0

Version:

1.2.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, 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

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, ChannelService channel, java.lang.Object data) Command executed with the specified source, timestamp, channel and data parameters.
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, 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

CommandListeners

public CommandListeners(CommandListener currentObject,
                        CommandListener newObject)

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

Parameters:

currentObject - The current object (CommandListener) parameter.

newObject - The new object (CommandListener) parameter.

See Also:

CommandListeners(CommandListener[])

CommandListeners

public CommandListeners(CommandListener[] objects)

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

Parameters:

objects - The objects (CommandListener[]) parameter.

See Also:

CommandListeners(CommandListener,CommandListener)

Method Detail

add

public static CommandListener add(CommandListener currentObject,
                                  CommandListener newObject)

Perform the add method and return the CommandListener result.

Parameters:

currentObject - The current object (CommandListener) parameter.

newObject - The new object (CommandListener) parameter.

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 - The current object (CommandListener) parameter.

removeObject - The remove object (CommandListener) parameter.

Returns:

Results of the remove (CommandListener) value.

See Also:

remove(CommandListener)

commandExecuted

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

Command executed with the specified source, timestamp, channel and data parameters.

Specified by:

commandExecuted in interface MultiplexCommandListener

Parameters:

source - The source (CommandService) parameter.

timestamp - The time stamp (Object) parameter.

channel - The channel (ChannelService) parameter.

data - The data (Object) parameter.

Since:

1.2

See Also:

commandExecuted(CommandService,Object,Object)

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

Specified by:

commandExecuted in interface CommandListener

Parameters:

source - The source (CommandService) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

See Also:

commandExecuted(CommandService,Object,ChannelService,Object)

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.

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 - The remove handler (CommandListener) parameter.

Returns:

Results of the remove (CommandListener) value.

See Also:

remove(CommandListener,CommandListener)