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, MultiplexMeasurementListener, MultiplexSignalListener, SignalListener, ErrorListener, ResponseListener

Direct Known Subclasses:

MessageCommand, SimpleDataCommand

public class SimpleMessageCommand
extends DeviceCommand
implements ResponseListener

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.

Since:

1.0

Version:

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

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

Method Summary

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.
MessageService	getMessage() Gets the MessageService message property value.
void	noResponseReceived(TransportService transportService, ChannelService channel, java.lang.Object timestamp, java.lang.Object data) No response received with the specified transport service, channel and data parameters.
void	responseReceived(TransportService transportService, ChannelService channel, java.lang.Object timestamp, java.lang.Object data) Response received with the specified transport service, channel and data parameters.
void	setMessage(MessageService message) Sets the message value.

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

getDevice, setDevice

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.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 - The message (MessageService) parameter.

Method Detail

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)

getMessage

public MessageService getMessage()

Gets the MessageService message property value.

Returns:

Results of the get message (MessageService) value.

See Also:

setMessage(MessageService)

noResponseReceived

public void noResponseReceived(TransportService transportService,
                               ChannelService channel,
                               java.lang.Object timestamp,
                               java.lang.Object data)

No response received with the specified transport service, channel and data parameters.

Specified by:

noResponseReceived in interface ResponseListener

Parameters:

transportService - The transport service (TransportService) parameter.

channel - The channel (ChannelService) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

Since:

1.2

responseReceived

public void responseReceived(TransportService transportService,
                             ChannelService channel,
                             java.lang.Object timestamp,
                             java.lang.Object data)

Response received with the specified transport service, channel and data parameters.

Specified by:

responseReceived in interface ResponseListener

Parameters:

transportService - The transport service (TransportService) parameter.

channel - The channel (ChannelService) parameter.

timestamp - The time stamp (Object) parameter.

data - The data (Object) parameter.

Since:

1.2

See Also:

noResponseReceived(TransportService,ChannelService,Object,Object)

setMessage

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

Sets the message value.

Parameters:

message - The message (MessageService) parameter.

Throws:

java.lang.IllegalArgumentException - Illegal Argument Exception.

See Also:

getMessage()