org.eclipse.soda.dk.parameter
Class ConstantOffsetParameter

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.parameter.Parameter
          org.eclipse.soda.dk.parameter.BitOffsetParameter
              org.eclipse.soda.dk.parameter.ByteOffsetParameter
                  org.eclipse.soda.dk.parameter.ConstantOffsetParameter

All Implemented Interfaces:

DataParameterService, ParameterService

public class ConstantOffsetParameter
extends ByteOffsetParameter

Version:

1.2.0

Field Summary

protected java.lang.Object

value Define the value (Object) field.

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

MASKS

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

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

ConstantOffsetParameter(java.lang.String key, int offset, int length, java.lang.Object value)
Constructs an instance of this class from the specified key, offset, length and value parameters.

ConstantOffsetParameter(java.lang.String key, int offset, int length, java.lang.Object value, short style)
Constructs an instance of this class from the specified key, offset, length, value and style parameters.

ConstantOffsetParameter(java.lang.String key, TransformService transform, int offset, int length, java.lang.Object value, short style)
Constructs an instance of this class from the specified key, transform, offset, length, value and style 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.Object	getValue() Gets the value (Object) value.
void	setValue(java.lang.Object value) Sets the value value.

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

getLength, setLength

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

decodeMessage, encodeMessage, getIndex, getMask, getOffset, getSize, setOffset

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

decode, decodeBytes, decodeEnd, decodeString, decodeValue, encode, encodeBegin, encodeBytes, encodeString, encodeValue, equals, getBytes, getDefaultStyle, getKey, getLong, getStyle, getTransform, getTypeStyle, isArray, isConstantParameter, isInsert, isLittleEndian, isUnsigned, setBits, setBytes, setKey, setStyle, setTransform, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

value

protected java.lang.Object value

Define the value (Object) field.

Constructor Detail

ConstantOffsetParameter

public ConstantOffsetParameter(java.lang.String key,
                               int offset,
                               int length,
                               java.lang.Object value)

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

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

value - The value (Object) parameter.

See Also:

ConstantOffsetParameter(String,int,int,Object,short), ConstantOffsetParameter(String,TransformService,int,int,Object,short)

ConstantOffsetParameter

public ConstantOffsetParameter(java.lang.String key,
                               int offset,
                               int length,
                               java.lang.Object value,
                               short style)

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

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

value - The value (Object) parameter.

style - The style (short) parameter.

See Also:

ConstantOffsetParameter(String,int,int,Object), ConstantOffsetParameter(String,TransformService,int,int,Object,short)

ConstantOffsetParameter

public ConstantOffsetParameter(java.lang.String key,
                               TransformService transform,
                               int offset,
                               int length,
                               java.lang.Object value,
                               short style)

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

Parameters:

key - The key (String) parameter.

transform - The transform (TransformService) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

value - The value (Object) parameter.

style - The style (short) parameter.

See Also:

ConstantOffsetParameter(String,int,int,Object), ConstantOffsetParameter(String,int,int,Object,short)

Method Detail

decodeValue

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

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

Specified by:

decodeValue in interface ParameterService

Overrides:

decodeValue in class Parameter

Parameters:

message - The message (MessageService) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode value (Object) value.

Throws:

java.lang.NumberFormatException - Number Format Exception.

See Also:

encodeValue(MessageService,Object,ParameterCursorService), getValue(), setValue(Object)

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 Parameter

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), getValue(), setValue(Object)

getValue

public java.lang.Object getValue()

Gets the value (Object) value.

Returns:

The value (Object) value.

See Also:

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

setValue

public void setValue(java.lang.Object value)

Sets the value value.

Parameters:

value - The value (Object) parameter.

See Also:

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