org.eclipse.soda.dk.message
Class ParameterMessage

java.lang.Object
  org.eclipse.soda.dk.message.Message
      org.eclipse.soda.dk.message.FilterMessage
          org.eclipse.soda.dk.message.ParameterMessage

All Implemented Interfaces:

java.lang.Cloneable, MessageService

Direct Known Subclasses:

ResponseMessage, TokenMessage

public class ParameterMessage
extends FilterMessage

The ParameterMessage class implements the MessageService interface.

Version:

1.0.0

See Also:

FilterMessage, Message, EscObject, Cloneable, MessageService, ParameterService

Field Summary

Fields inherited from interface org.eclipse.soda.dk.message.service.MessageService

HIGH_PRIORITY, LOW_PRIORITY, MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY, STRING, THREAD_PRIORITY

Constructor Summary

ParameterMessage(byte[] data, FilterService filter, ParameterService parameter)
Constructs an ParameterMessage object using the input parameter(s).

ParameterMessage(byte[] data, ParameterService parameter)
Constructs an instance of this class from the specified data and parameter parameters.

Method Summary

java.lang.Object	decodeMessage(MessageService message) Perform the decodeValue method and return the Object result.
java.lang.Object	decodeMessage(MessageService message, ParameterService parameter) Perform the decodeValue method and return the Object result.
MessageService	encodeMessage(MessageService message, java.lang.Object value) Perform the encodeValue method and return the MessageService result.
MessageService	encodeMessage(MessageService message, ParameterService parameter, java.lang.Object value) Perform the encodeValue method and return the MessageService result.
ParameterService	getParameter() Gets the ParameterService parameter property value.
ParameterService	lookup(ParameterService parameter) Lookup with the specified parameter parameter and return the ParameterService result.
protected void	setParameter(ParameterService parameter) Sets the parameter property.

Methods inherited from class org.eclipse.soda.dk.message.FilterMessage

getFilter, matches, setFilter

Methods inherited from class org.eclipse.soda.dk.message.Message

clone, equals, get, getBoolean, getByte, getBytes, getData, getDataBytes, getDataLength, getDataOffset, getInt, getIntByte, getIntByte, getKey, getLittleEndianInt, getLittleEndianLong, getLong, getLongByte, getLongByte, getPriority, getShort, hashCode, isBigEndian, length, put, setBoolean, setByte, setBytes, setData, setInt, setLong, setShort, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterMessage

public ParameterMessage(byte[] data,
                        ParameterService parameter)

Constructs an instance of this class from the specified data and parameter parameters.

Parameters:

data - The data (byte[]) parameter.

parameter - The parameter (ParameterService) parameter.

See Also:

ParameterMessage(byte[],FilterService,ParameterService)

ParameterMessage

public ParameterMessage(byte[] data,
                        FilterService filter,
                        ParameterService parameter)

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

Parameters:

data - byte[]

filter - org.eclipse.soda.dk.filter.service.FilterService

parameter - org.eclipse.soda.dk.tk.ParameterService

See Also:

ParameterMessage(byte[],ParameterService)

Method Detail

decodeMessage

public java.lang.Object decodeMessage(MessageService message)

Perform the decodeValue method and return the Object result.

Specified by:

decodeMessage in interface MessageService

Overrides:

decodeMessage in class Message

Parameters:

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

Returns:

Results of the decode message (Object) value.

See Also:

ParameterService.decodeValue(org.eclipse.soda.dk.message.service.MessageService), ParameterMessage(byte[],ParameterService), ParameterMessage(byte[],FilterService,ParameterService), decodeMessage(MessageService,ParameterService), encodeMessage(MessageService,Object), encodeMessage(MessageService,ParameterService,Object)

decodeMessage

public java.lang.Object decodeMessage(MessageService message,
                                      ParameterService parameter)

Perform the decodeValue method and return the Object result.

Specified by:

decodeMessage in interface MessageService

Overrides:

decodeMessage in class Message

Parameters:

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

parameter - The parameter (ParameterService) parameter.

Returns:

Results of the decode message (Object) value.

See Also:

ParameterService.decodeValue(org.eclipse.soda.dk.message.service.MessageService), ParameterMessage(byte[],ParameterService), ParameterMessage(byte[],FilterService,ParameterService), decodeMessage(MessageService), encodeMessage(MessageService,Object), encodeMessage(MessageService,ParameterService,Object)

encodeMessage

public MessageService encodeMessage(MessageService message,
                                    java.lang.Object value)

Perform the encodeValue method and return the MessageService result.

Specified by:

encodeMessage in interface MessageService

Overrides:

encodeMessage in class Message

Parameters:

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

value - java.lang.Object

Returns:

Results of the encode message (MessageService) value.

See Also:

ParameterService.encodeValue(org.eclipse.soda.dk.message.service.MessageService, java.lang.Object), ParameterMessage(byte[],ParameterService), ParameterMessage(byte[],FilterService,ParameterService), decodeMessage(MessageService), decodeMessage(MessageService,ParameterService), encodeMessage(MessageService,ParameterService,Object)

encodeMessage

public MessageService encodeMessage(MessageService message,
                                    ParameterService parameter,
                                    java.lang.Object value)

Perform the encodeValue method and return the MessageService result.

Specified by:

encodeMessage in interface MessageService

Overrides:

encodeMessage in class Message

Parameters:

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

value - java.lang.Object

parameter - The parameter (ParameterService) parameter.

Returns:

Results of the encode message (MessageService) value.

See Also:

ParameterService.encodeValue(org.eclipse.soda.dk.message.service.MessageService, java.lang.Object), ParameterMessage(byte[],ParameterService), ParameterMessage(byte[],FilterService,ParameterService), decodeMessage(MessageService), decodeMessage(MessageService,ParameterService), encodeMessage(MessageService,Object)

getParameter

public ParameterService getParameter()

Gets the ParameterService parameter property value.

Overrides:

getParameter in class Message

Returns:

Results of the get parameter (ParameterService) value.

See Also:

setParameter(ParameterService)

lookup

public ParameterService lookup(ParameterService parameter)

Lookup with the specified parameter parameter and return the ParameterService result.

Specified by:

lookup in interface MessageService

Overrides:

lookup in class Message

Parameters:

parameter - The parameter (ParameterService) parameter.

Returns:

Results of the lookup (ParameterService) value.

setParameter

protected void setParameter(ParameterService parameter)

Sets the parameter property.

Parameters:

parameter - The new property value (org.eclipse.soda.dk.tk.ParameterService).

See Also:

getParameter()