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, ControlService, MeasurementListener, SignalListener, ErrorListener

public class Commands
extends Command
implements CommandListener

The Commands class implements the CommandService interface.

Version:

1.0.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, SETVALUEEXCEPTION_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, 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

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, java.lang.Object data) This method is fired to all Listeners each time the command is executed.
void	execute() Perform the execute action method.
void	execute(java.lang.Object object) Perform the execute action method.
CommandService[]	getCommands() Gets the org.eclipse.soda.dk.command.service.CommandService [] commands property value.
protected void	setCommands(CommandService[] commands) Sets the commands property.

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

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

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

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

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

createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, 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, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, 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 - java.lang.String

commands - org.eclipse.soda.dk.command.service.CommandService[]

See Also:

getCommands(), setCommands(CommandService[])

Method Detail

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.

execute

public void execute()

Perform the execute action method.

Specified by:

execute in interface CommandService

Overrides:

execute in class Command

See Also:

CommandService.execute(), execute(Object)

execute

public void execute(java.lang.Object object)

Perform the execute action method.

Specified by:

execute in interface CommandService

Overrides:

execute in class Command

Parameters:

object - java.lang.Object

See Also:

CommandService.execute(), execute()

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 property.

Parameters:

commands - The new property value (org.eclipse.soda.dk.command.service.CommandService[]).

See Also:

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