org.eclipse.soda.dk.parameter
Class StreamOffsetParameter

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.parameter.StreamParameter
          org.eclipse.soda.dk.parameter.StreamLengthParameter
              org.eclipse.soda.dk.parameter.StreamOffsetParameter

All Implemented Interfaces:

DataParameterService, ParameterService

public class StreamOffsetParameter
extends StreamLengthParameter

Version:

1.2.0

Field Summary

protected int

offset Define the offset (int) field.

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

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

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

StreamOffsetParameter(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.

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

Method Summary

int	getOffset() Gets the offset (int) value.
protected int	getOffset(ParameterCursorService cursor) Get offset with the specified cursor parameter and return the int result.
int	getOffsetDefault() Gets the offset default (int) value.
void	setOffset(int offset) Sets the offset value.

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

getLength, getLength, getLengthDefault, setLength

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

decode, decodeBytes, decodeEnd, decodeMessage, decodeString, decodeValue, decodeValue, encode, encodeString, encodeValue, encodeValue, getBytes, getDefaultStyle, getExternalStyle, getExternalTypeStyle, getKey, getLong, getOffsetLength, getStyle, getTransform, getTypeStyle, isArray, isConstantParameter, isInsert, isLittleEndian, isUnsigned, setBits, setBytes, setExternalStyle, setKey, setStyle, 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

Field Detail

offset

protected int offset

Define the offset (int) field.

Constructor Detail

StreamOffsetParameter

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

StreamOffsetParameter(String,int,int,short), StreamOffsetParameter(String,int,int,short,short)

StreamOffsetParameter

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

StreamOffsetParameter(String,int,int), StreamOffsetParameter(String,int,int,short,short)

StreamOffsetParameter

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

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

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

style - The style (short) parameter.

externalStyle - The external style (short) parameter.

See Also:

StreamOffsetParameter(String,int,int), StreamOffsetParameter(String,int,int,short)

Method Detail

getOffset

public int getOffset()

Gets the offset (int) value.

Returns:

The offset (int) value.

See Also:

getOffset(ParameterCursorService), setOffset(int)

getOffset

protected int getOffset(ParameterCursorService cursor)

Get offset with the specified cursor parameter and return the int result.

Overrides:

getOffset in class StreamParameter

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get offset (int) value.

See Also:

getOffset(), setOffset(int)

getOffsetDefault

public int getOffsetDefault()

Gets the offset default (int) value.

Overrides:

getOffsetDefault in class StreamParameter

Returns:

The offset default (int) value.

setOffset

public void setOffset(int offset)

Sets the offset value.

Parameters:

offset - The offset (int) parameter.

See Also:

getOffset(), getOffset(ParameterCursorService)