org.eclipse.soda.dk.parameter
Class MapParameters

java.lang.Object
  org.eclipse.soda.dk.parameter.Parameters
      org.eclipse.soda.dk.parameter.MapParameters

All Implemented Interfaces:

DataParameterService, ParameterService

Direct Known Subclasses:

ListParameters, VariableListParameters

public class MapParameters
extends Parameters
implements ParameterService

Version:

1.2.0

Field Summary

protected int

offset Define the offset (int) field.

Fields inherited from class org.eclipse.soda.dk.parameter.Parameters

parameters

Fields inherited from interface org.eclipse.soda.dk.parameter.service.ParameterService

ARRAY, ASCII, ASCIIZ, BOOLEAN, BYTE, BYTES, DOUBLE, FLOAT, HEXASCII, HEXSTRING, INSERT, INTEGER, LITTLEENDIAN, LONG, NASCII, NSTRING, NULL, SERVICE_NAME, SHORT, STRING, UNLIMITED, UNSIGNED, USE_CURSOR, USE_CURSOR_INSERT

Constructor Summary

MapParameters(java.lang.String key, ParameterService[] parameters)
Constructs an instance of this class from the specified key and parameters parameters.

MapParameters(java.lang.String key, ParameterService[] parameters, int offset)
Constructs an instance of this class from the specified key, parameters and offset parameters.

Method Summary

java.lang.Object	decodeValue(MessageService message, ParameterCursorService cursor) Perform the decodeValue method and return the Object result.
MessageService	encodeValue(MessageService message, java.lang.Object value, ParameterCursorService cursor) Perform the encodeValue method and return the MessageService result.
int	getOffset() Gets the offset (int) value.
void	setOffset(int offset) Sets the offset value.

Methods inherited from class org.eclipse.soda.dk.parameter.Parameters

decode, decodeValue, encode, encodeValue, equals, getKey, getLength, getParameters, hashCode, isConstantParameter, setKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.soda.dk.parameter.service.ParameterService

decodeValue, encodeValue, getKey, isConstantParameter

Methods inherited from interface org.eclipse.soda.dk.data.parameter.service.DataParameterService

decode, encode

Field Detail

offset

protected int offset

Define the offset (int) field.

Constructor Detail

MapParameters

public MapParameters(java.lang.String key,
                     ParameterService[] parameters)

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

Parameters:

key - The key (String) parameter.

parameters - The parameters (ParameterService[]) parameter.

See Also:

MapParameters(String,ParameterService[],int)

MapParameters

public MapParameters(java.lang.String key,
                     ParameterService[] parameters,
                     int offset)

Constructs an instance of this class from the specified key, parameters and offset parameters.

Parameters:

key - The key (String) parameter.

parameters - The parameters (ParameterService[]) parameter.

offset - The offset (int) parameter.

See Also:

MapParameters(String,ParameterService[])

Method Detail

decodeValue

public java.lang.Object decodeValue(MessageService message,
                                    ParameterCursorService cursor)

Perform the decodeValue method and return the Object result.

Specified by:

decodeValue in interface ParameterService

Overrides:

decodeValue in class Parameters

Parameters:

message - The message (MessageService) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode value (Object) value.

See Also:

encodeValue(MessageService,Object,ParameterCursorService)

encodeValue

public MessageService encodeValue(MessageService message,
                                  java.lang.Object value,
                                  ParameterCursorService cursor)

Perform the encodeValue method and return the MessageService result.

Specified by:

encodeValue in interface ParameterService

Overrides:

encodeValue in class Parameters

Parameters:

message - The message (MessageService) parameter.

value - The value (Object) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the encode value (MessageService) value.

See Also:

decodeValue(MessageService,ParameterCursorService)

getOffset

public int getOffset()

Gets the offset (int) value.

Returns:

The offset (int) value.

See Also:

setOffset(int)

setOffset

public void setOffset(int offset)

Sets the offset value.

Parameters:

offset - The offset (int) parameter.

See Also:

getOffset()