org.eclipse.soda.dk.parameter
Class VariableLengthParameter

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.parameter.BaseParameter
          org.eclipse.soda.dk.parameter.BaseKeyParameter
              org.eclipse.soda.dk.parameter.MultiParameter
                  org.eclipse.soda.dk.parameter.VariableLengthParameter

All Implemented Interfaces:

DataParameterService, ParameterService

public class VariableLengthParameter
extends MultiParameter

Version:

1.2.0

Field Summary

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

key

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

BIT_MASKS, MASKS, SET_MASKS, SET_TOP_MASKS

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

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

VariableLengthParameter()
Constructs an instance of this class.

VariableLengthParameter(ParameterService[] parameters)
Constructs an instance of this class from the specified parameters parameter.

VariableLengthParameter(java.lang.String key)
Constructs an instance of this class from the specified key parameter.

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

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

Method Summary

java.lang.Object	decodeValue(MessageService message, ParameterCursorService cursor) Decode value with the specified message and cursor parameters and return the Object result.
MessageService	encodeValue(MessageService message, java.lang.Object value, ParameterCursorService cursor) Encode value with the specified message, value and cursor parameters and return the MessageService result.
java.lang.String	getKey() Gets the key (String) value.
boolean	needsCursor() Needs cursor and return the boolean result.

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

decodeValue, encodeValue, encodeValueList, getCountBlock, getParameters, setCountBlock, setParameters

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

setKey

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

createCursorChild, decode, decodeBytes, decodeEnd, decodeString, decodeValue, encode, encodeBytes, encodeData, encodeString, encodeValue, expand, expand, getAbsoluteOffset, getBytes, getDefaultStyle, getLength, getLength, getLittleEndianLong, getLong, getOffset, getOffsetAbsolute, getOffsetDefault, getOffsetLength, getOffsetValue, getUnsignedInteger, getUnsignedLittleEndianLong, getUnsignedLittleEngianLong, getUnsignedLong, isConstantParameter, isInsert, isInsert, setBits, setBits, setBits, setBitsLittleEngian, setBytes, setBytes, setBytes, setBytesLittleEndian, updateCursor, updateCursor

Methods inherited from class org.eclipse.soda.dk.core.EscObject

attemptRecoveryFromError, createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getErrorSeverity, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogLevel, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getResource, 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, reportError, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VariableLengthParameter

public VariableLengthParameter()

Constructs an instance of this class.

See Also:

VariableLengthParameter(ParameterService[]), VariableLengthParameter(String), VariableLengthParameter(String,ParameterService[]), VariableLengthParameter(String,ParameterService[],ParameterService)

VariableLengthParameter

public VariableLengthParameter(ParameterService[] parameters)

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

Parameters:

parameters - The parameters (ParameterService[]) parameter.

See Also:

VariableLengthParameter(), VariableLengthParameter(String), VariableLengthParameter(String,ParameterService[]), VariableLengthParameter(String,ParameterService[],ParameterService)

VariableLengthParameter

public VariableLengthParameter(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

See Also:

VariableLengthParameter(), VariableLengthParameter(ParameterService[]), VariableLengthParameter(String,ParameterService[]), VariableLengthParameter(String,ParameterService[],ParameterService)

VariableLengthParameter

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

VariableLengthParameter(), VariableLengthParameter(ParameterService[]), VariableLengthParameter(String), VariableLengthParameter(String,ParameterService[],ParameterService)

VariableLengthParameter

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

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

Parameters:

key - The key (String) parameter.

parameters - The parameters (ParameterService[]) parameter.

countBlock - The count block (ParameterService) parameter.

See Also:

VariableLengthParameter(), VariableLengthParameter(ParameterService[]), VariableLengthParameter(String), VariableLengthParameter(String,ParameterService[])

Method Detail

decodeValue

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

Decode value with the specified message and cursor parameters and return the Object result.

Specified by:

decodeValue in interface ParameterService

Overrides:

decodeValue in class MultiParameter

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)

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

Specified by:

encodeValue in interface ParameterService

Overrides:

encodeValue in class MultiParameter

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)

getKey

public java.lang.String getKey()

Gets the key (String) value.

Specified by:

getKey in interface ParameterService

Overrides:

getKey in class BaseKeyParameter

Returns:

The key (String) value.

See Also:

BaseKeyParameter.setKey(String)

needsCursor

public boolean needsCursor()

Needs cursor and return the boolean result.

Overrides:

needsCursor in class MultiParameter

Returns:

Results of the needs cursor (boolean) value.

See Also:

BaseParameter.updateCursor(ParameterCursorService), BaseParameter.updateCursor(ParameterCursorService,int)