org.eclipse.soda.dk.command
Class SimpleMessageCommand

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.DeviceCommand
                  org.eclipse.soda.dk.command.SimpleMessageCommand

All Implemented Interfaces:

CommandService, ControlService, DeviceControl, MeasurementListener, SignalListener, ErrorListener

Direct Known Subclasses:

MessageCommand, SimpleDataCommand

public class SimpleMessageCommand
extends DeviceCommand

This command class implements a command with a message that is sent to the device and is not received from the device. This class should not be used if the message contains a parameter or a command parameter has been specified.

Version:

1.0.0

Field Summary

protected MessageService

message Define the message (MessageService) field.

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

SimpleMessageCommand(java.lang.String key, MessageService message)
Constructs an instance of this class from the specified key parameter.

Method Summary

void	execute() Perform the execute action method.
void	execute(java.lang.Object data) Perform the execute action method.
MessageService	getMessage() Gets the MessageService message property value.
void	setMessage(MessageService message) Sets the message property.

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

getDevice, setDevice

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.device.service.ControlService

getKey

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

errorOccurred

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

errorOccurred

Field Detail

message

protected MessageService message

Define the message (MessageService) field.

Constructor Detail

SimpleMessageCommand

public SimpleMessageCommand(java.lang.String key,
                            MessageService message)

Constructs an instance of this class from the specified key parameter.

Parameters:

key - The key (String) parameter.

message - org.eclipse.soda.dk.message.service.MessageService

Method Detail

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 data)
             throws java.lang.IllegalArgumentException

Perform the execute action method.

Specified by:

execute in interface CommandService

Overrides:

execute in class Command

Parameters:

data - java.lang.Object

Throws:

java.lang.IllegalArgumentException - Illegal Argument Exception if data is not null.

See Also:

CommandService.execute(), execute()

getMessage

public MessageService getMessage()

Gets the MessageService message property value.

Returns:

Results of the get message (MessageService) value.

See Also:

setMessage(MessageService)

setMessage

public void setMessage(MessageService message)
                throws java.lang.IllegalArgumentException

Sets the message property.

Parameters:

message - The new property value (org.eclipse.soda.dk.message.service.MessageService).

Throws:

java.lang.IllegalArgumentException - Illegal Argument Exception.

See Also:

getMessage()