org.eclipse.soda.dk.parameter
Class Parameters

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

All Implemented Interfaces:

DataParameterService, ParameterService

Direct Known Subclasses:

MapParameters

public class Parameters
extends java.lang.Object
implements ParameterService, DataParameterService

Version:

1.2.0

Field Summary

protected ParameterService[]

parameters Define the parameters (ParameterService[]) field.

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

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

Method Summary

java.lang.Object	decode(java.lang.Object container) Decode with the specified container parameter and return the Object result.
java.lang.Object	decodeValue(MessageService message) Decode value with the specified message parameter and return the Object result.
java.lang.Object	decodeValue(MessageService message, ParameterCursorService cursor) Perform the decodeValue method and return the Object result.
java.lang.Object	encode(java.lang.Object container, java.lang.Object data) Encode with the specified container and data parameters and return the Object result.
MessageService	encodeValue(MessageService message, java.lang.Object value) Encode value with the specified message and value parameters and return the MessageService result.
MessageService	encodeValue(MessageService message, java.lang.Object value, ParameterCursorService cursor) Perform the encodeValue method and return the MessageService result.
boolean	equals(java.lang.Object obj) Compares two objects for equality.
java.lang.String	getKey() Gets the key (String) value.
int	getLength(MessageService message, ParameterCursorService cursor) Get length with the specified message and cursor parameters and return the int result.
ParameterService[]	getParameters() Gets the parameters (ParameterService[]) value.
int	hashCode() Generates a hash code for the receiver.
boolean	isConstantParameter() Gets the constant parameter (boolean) value.
void	setKey(java.lang.String key) Sets the key value.

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected ParameterService[] parameters

Define the parameters (ParameterService[]) field.

Constructor Detail

Parameters

public Parameters(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:

getParameters()

Method Detail

decode

public java.lang.Object decode(java.lang.Object container)

Decode with the specified container parameter and return the Object result.

Specified by:

decode in interface DataParameterService

Parameters:

container - The container (Object) parameter.

Returns:

Results of the decode (Object) value.

decodeValue

public java.lang.Object decodeValue(MessageService message)

Decode value with the specified message parameter and return the Object result.

Specified by:

decodeValue in interface ParameterService

Parameters:

message - The message (MessageService) parameter.

Returns:

Results of the decode value (Object) value.

See Also:

decodeValue(MessageService,ParameterCursorService), encodeValue(MessageService,Object), encodeValue(MessageService,Object,ParameterCursorService)

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

Parameters:

message - The message (MessageService) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode value (Object) value.

See Also:

decodeValue(MessageService), encodeValue(MessageService,Object), encodeValue(MessageService,Object,ParameterCursorService)

encode

public java.lang.Object encode(java.lang.Object container,
                               java.lang.Object data)

Encode with the specified container and data parameters and return the Object result.

Specified by:

encode in interface DataParameterService

Parameters:

container - The container (Object) parameter.

data - The data (Object) parameter.

Returns:

Results of the encode (Object) value.

encodeValue

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

Encode value with the specified message and value parameters and return the MessageService result.

Specified by:

encodeValue in interface ParameterService

Parameters:

message - The message (MessageService) parameter.

value - The value (Object) parameter.

Returns:

Results of the encode value (MessageService) value.

See Also:

decodeValue(MessageService), decodeValue(MessageService,ParameterCursorService), 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

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), decodeValue(MessageService,ParameterCursorService), encodeValue(MessageService,Object)

equals

public boolean equals(java.lang.Object obj)

Compares two objects for equality. Returns a boolean that indicates whether this object is equivalent to the specified object. This method is used when an object is stored in a hashtable.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The obj (Object) parameter.

Returns:

true if these Objects are equal; false otherwise.

See Also:

Hashtable

getKey

public java.lang.String getKey()

Gets the key (String) value.

Specified by:

getKey in interface ParameterService

Returns:

The key (String) value.

See Also:

setKey(String)

getLength

public int getLength(MessageService message,
                     ParameterCursorService cursor)

Get length with the specified message and cursor parameters and return the int result.

Parameters:

message - The message (MessageService) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get length (int) value.

getParameters

public ParameterService[] getParameters()

Gets the parameters (ParameterService[]) value.

Returns:

The parameters (ParameterService[]) value.

See Also:

Parameters(String,ParameterService[])

hashCode

public int hashCode()

Generates a hash code for the receiver. This method is supported primarily for hash tables, such as those provided in java.util.

Overrides:

hashCode in class java.lang.Object

Returns:

an integer hash code for the receiver

See Also:

Hashtable

isConstantParameter

public boolean isConstantParameter()

Gets the constant parameter (boolean) value.

Specified by:

isConstantParameter in interface ParameterService

Returns:

The constant parameter (boolean) value.

setKey

public void setKey(java.lang.String key)

Sets the key value.

Parameters:

key - The key (String) parameter.

See Also:

getKey()