org.eclipse.soda.dk.parameter
Class OffsetParameter

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.parameter.Parameter
          org.eclipse.soda.dk.parameter.OffsetParameter

All Implemented Interfaces:

DataParameterService, ParameterService

public class OffsetParameter
extends Parameter

The OffsetParameter class implements the ParameterService interface.

Since:

1.0

Version:

1.2.0

See Also:

Parameter, ParameterService

Field Summary

static int[]

MASKS Define the masks (int) field.

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

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

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

OffsetParameter(java.lang.String key, TransformService transform, int offset, int length)
Constructs an instance of this class from the specified key, transform, offset and length parameters.

OffsetParameter(java.lang.String key, TransformService transform, int offset, int length, short style)
Constructs an OffsetParameter object using the input parameter(s).

Method Summary

java.lang.Object	decodeBytes(byte[] container, ParameterCursorService cursor) Decode bytes with the specified container parameter and return the Object result.
protected java.lang.Object	decodeMessage(MessageService message, ParameterCursorService cursor) Perform the decodeMessage method and return the Object result.
java.lang.Object	encodeBytes(byte[] container, java.lang.Object data, ParameterCursorService cursor) Encode bytes with the specified container and data parameters 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.
byte[]	getBytesValue(java.lang.Object value, int length) Get bytes value with the specified value and length parameters and return the byte[] result.
protected int	getIndex(ParameterCursorService cursor) Gets the int index property value.
protected int	getLength(ParameterCursorService cursor) Gets the int length property value.
protected int	getMask() Gets the int mask property value.
protected int	getOffset(ParameterCursorService cursor) Gets the int offset property value.
protected int	getSize(ParameterCursorService cursor) Gets the int size property value.
protected void	setLength(int length) Sets the length value.
protected void	setOffset(int offset) Sets the offset value.
protected void	updateCursor(ParameterCursorService cursor) Update cursor with the specified cursor parameter.

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

decode, decodeEnd, decodeString, decodeValue, decodeValue, encode, encodeBegin, encodeString, encodeValue, encodeValue, equals, getBytes, getDefaultStyle, getKey, getLong, getStyle, getTransform, getTypeStyle, isArray, isConstantParameter, isInsert, isLittleEndian, isUnsigned, setBits, setBytes, setKey, setStyle, setTransform

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

MASKS

public static final int[] MASKS

Define the masks (int) field.

Constructor Detail

OffsetParameter

public OffsetParameter(java.lang.String key,
                       int offset,
                       int length)

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

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

See Also:

OffsetParameter(String,int,int,short), OffsetParameter(String,TransformService,int,int), OffsetParameter(String,TransformService,int,int,short)

OffsetParameter

public OffsetParameter(java.lang.String key,
                       int offset,
                       int length,
                       short style)

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

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

style - The style (short) parameter.

See Also:

OffsetParameter(String,int,int), OffsetParameter(String,TransformService,int,int), OffsetParameter(String,TransformService,int,int,short)

OffsetParameter

public OffsetParameter(java.lang.String key,
                       TransformService transform,
                       int offset,
                       int length)

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

Parameters:

key - The key (String) parameter.

transform - The transform (TransformService) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

See Also:

OffsetParameter(String,int,int), OffsetParameter(String,int,int,short), OffsetParameter(String,TransformService,int,int,short)

OffsetParameter

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

Constructs an OffsetParameter object using the input parameter(s).

Parameters:

key - The key (String) parameter.

transform - The transform (TransformService) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

style - The style (short) parameter.

See Also:

OffsetParameter(String,int,int), OffsetParameter(String,int,int,short), OffsetParameter(String,TransformService,int,int)

Method Detail

decodeBytes

public java.lang.Object decodeBytes(byte[] container,
                                    ParameterCursorService cursor)

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

Overrides:

decodeBytes in class Parameter

Parameters:

container - The container (byte[]) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode bytes (Object) value.

See Also:

encodeBytes(byte[],Object,ParameterCursorService)

decodeMessage

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

Perform the decodeMessage method and return the Object result.

Overrides:

decodeMessage in class Parameter

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)

encodeBytes

public java.lang.Object encodeBytes(byte[] container,
                                    java.lang.Object data,
                                    ParameterCursorService cursor)

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

Overrides:

encodeBytes in class Parameter

Parameters:

container - The container (byte[]) parameter.

data - The data (Object) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the encode bytes (Object) value.

See Also:

decodeBytes(byte[],ParameterCursorService)

encodeMessage

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

Perform the encodeMessage method and return the MessageService result.

Overrides:

encodeMessage in class Parameter

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)

getBytesValue

public byte[] getBytesValue(java.lang.Object value,
                            int length)

Get bytes value with the specified value and length parameters and return the byte[] result.

Parameters:

value - The value (Object) parameter.

length - The length (int) parameter.

Returns:

Results of the get bytes value (byte[]) value.

getIndex

protected int getIndex(ParameterCursorService cursor)

Gets the int index property value.

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get index (int) value.

getLength

protected int getLength(ParameterCursorService cursor)

Gets the int length property value.

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get length (int) value.

See Also:

setLength(int)

getMask

protected int getMask()

Gets the int mask property value.

Returns:

Results of the get mask (int) value.

getOffset

protected int getOffset(ParameterCursorService cursor)

Gets the int offset property value.

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get offset (int) value.

See Also:

setOffset(int)

getSize

protected int getSize(ParameterCursorService cursor)

Gets the int size property value.

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get size (int) value.

setLength

protected void setLength(int length)

Sets the length value.

Parameters:

length - The length (int) parameter.

See Also:

getLength(ParameterCursorService)

setOffset

protected void setOffset(int offset)

Sets the offset value.

Parameters:

offset - The offset (int) parameter.

See Also:

getOffset(ParameterCursorService)

updateCursor

protected void updateCursor(ParameterCursorService cursor)

Update cursor with the specified cursor parameter.

Overrides:

updateCursor in class Parameter

Parameters:

cursor - The cursor (ParameterCursorService) parameter.