org.eclipse.soda.dk.parameter
Class ComplexStreamParameter

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.parameter.ComplexStreamParameter

public class ComplexStreamParameter
extends EscObject

The OffsetParameter class implements the ParameterService interface.

Since:

1.0

Version:

1.2.0

See Also:

Parameter, ParameterService

Field Summary

protected java.lang.String	key Define the key (String) field.
protected ParameterService[]	parameters Define the parameters (ParameterService[]) field.

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

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

Method Summary

protected java.lang.Object	decodeMessage(MessageService message, ParameterCursorService cursor) Perform the decodeMessage method and return the Object result.
MessageService	encodeMessage(MessageService message, java.lang.Object value, int offset, ParameterCursorService cursor) Perform the encodeMessage method and return the MessageService result.
java.lang.String	getKey() Gets the key (String) value.
ParameterService[]	getParameters() Gets the parameters (ParameterService[]) value.
boolean	isConstantParameter() Gets the constant parameter (boolean) value.
void	setKey(java.lang.String key) Sets the key value.
void	setParameters(ParameterService[] parameters) Sets the parameters value.

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

Field Detail

parameters

protected ParameterService[] parameters

Define the parameters (ParameterService[]) field.

key

protected java.lang.String key

Define the key (String) field.

Constructor Detail

ComplexStreamParameter

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

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

Parameters:

key - The key (String) parameter.

parameters - The parameters (ParameterService[]) parameter.

Method Detail

decodeMessage

protected java.lang.Object decodeMessage(MessageService message,
                                         ParameterCursorService cursor)

Perform the decodeMessage method and return the Object result.

Parameters:

message - The message (MessageService) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode message (Object) value.

See Also:

encodeMessage(MessageService,Object,int,ParameterCursorService)

encodeMessage

public MessageService encodeMessage(MessageService message,
                                    java.lang.Object value,
                                    int offset,
                                    ParameterCursorService cursor)

Perform the encodeMessage method and return the MessageService result.

Parameters:

message - The message (MessageService) parameter.

value - The value (Object) parameter.

offset - The offset (int) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the encode message (MessageService) value.

See Also:

decodeMessage(MessageService,ParameterCursorService)

getKey

public java.lang.String getKey()

Gets the key (String) value.

Returns:

The key (String) value.

See Also:

setKey(String)

getParameters

public ParameterService[] getParameters()

Gets the parameters (ParameterService[]) value.

Returns:

The parameters (ParameterService[]) value.

See Also:

setParameters(ParameterService[])

isConstantParameter

public boolean isConstantParameter()

Gets the constant parameter (boolean) value.

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()

setParameters

public void setParameters(ParameterService[] parameters)

Sets the parameters value.

Parameters:

parameters - The parameters (ParameterService[]) parameter.

See Also:

getParameters()