org.eclipse.soda.dk.command
Class Commands

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.command.Command
              org.eclipse.soda.dk.command.Commands

All Implemented Interfaces:

CommandListener, CommandService, MultiplexCommandListener, ControlService, MeasurementListener, MultiplexMeasurementListener, MultiplexSignalListener, SignalListener, ErrorListener

public class Commands
extends Command
implements MultiplexCommandListener

The Commands class implements the CommandService interface.

Since:

1.0

Version:

1.2.0

See Also:

Command, Control, CommandService, CommandListener, ControlService, ErrorListener, MeasurementListener, MessageHandler, SignalListener

Field Summary

Fields inherited from class org.eclipse.soda.dk.device.Control

EXCEPTION_READ_FAILED_RESOURCE, SET_VALUE_EXCEPTION_RESOURCE

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

Commands(java.lang.String key, CommandService[] commands)
Constructs an Commands object using the input parameter(s).

Method Summary

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	execute(ChannelService channel) Execute with the specified channel parameter.
void	execute(ChannelService channel, java.lang.Object data) Execute with the specified channel and data parameters.
CommandService[]	getCommands() Gets the org.eclipse.soda.dk.command.service.CommandService [] commands property value.
protected void	setCommands(CommandService[] commands) Sets the commands value.

Methods inherited from class org.eclipse.soda.dk.command.Command

addCommandListener, execute, execute, fireCommandExecuted, fireCommandExecuted, fireCommandExecuted, fireCommandExecuted, fireErrorOccurred, fireErrorOccurred, getCommandListener, measurementChanged, measurementChanged, removeCommandListener, reportError, setCommandListener, signalOccurred, signalOccurred

Methods inherited from class org.eclipse.soda.dk.device.Control

attemptRecoveryFromError, equalsValue, errorOccurred, findMethod, getCodeKey, getErrorSeverity, getKey, getQualifiedKey, getResource, setKey, setQualifiedKey, toString

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

createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogLevel, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, 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, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.soda.dk.transport.service.ErrorListener

errorOccurred

Methods inherited from interface org.eclipse.soda.dk.device.service.ControlService

getKey

Constructor Detail

Commands

public Commands(java.lang.String key,
                CommandService[] commands)

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

Parameters:

key - The key (String) parameter.

commands - The commands (CommandService[]) parameter.

See Also:

getCommands(), setCommands(CommandService[])

Method Detail

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)

execute

public void execute(ChannelService channel)

Execute with the specified channel parameter.

Specified by:

execute in interface CommandService

Overrides:

execute in class Command

Parameters:

channel - The channel (ChannelService) parameter.

See Also:

execute(ChannelService,Object)

execute

public void execute(ChannelService channel,
                    java.lang.Object data)

Execute with the specified channel and data parameters.

Specified by:

execute in interface CommandService

Overrides:

execute in class Command

Parameters:

channel - The channel (ChannelService) parameter.

data - The data (Object) parameter.

See Also:

execute(ChannelService)

getCommands

public CommandService[] getCommands()

Gets the org.eclipse.soda.dk.command.service.CommandService [] commands property value.

Returns:

Results of the get commands (CommandService[]) value.

See Also:

Commands(String,CommandService[]), setCommands(CommandService[])

setCommands

protected void setCommands(CommandService[] commands)

Sets the commands value.

Parameters:

commands - The commands (CommandService[]) parameter.

See Also:

Commands(String,CommandService[]), getCommands()