org.eclipse.soda.dk.parameter
Class StreamLengthParameter

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

All Implemented Interfaces:

DataParameterService, ParameterService

Direct Known Subclasses:

StreamOffsetParameter

public class StreamLengthParameter
extends StreamParameter

Version:

1.2.0

Field Summary

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

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

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

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

Method Summary

int	getLength() Gets the length (int) value.
protected int	getLength(ParameterCursorService cursor) Get length with the specified cursor parameter and return the int result.
int	getLengthDefault() Gets the length default (int) value.
void	setLength(int length) Sets the length value.

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, getOffset, getOffsetDefault, 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

Constructor Detail

StreamLengthParameter

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

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

Parameters:

key - The key (String) parameter.

length - The length (int) parameter.

style - The style (short) parameter.

externalStyle - The external style (short) parameter.

See Also:

StreamLengthParameter(String,int), StreamLengthParameter(String,int,short)

StreamLengthParameter

public StreamLengthParameter(java.lang.String key,
                             int length)

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

Parameters:

key - The key (String) parameter.

length - The length (int) parameter.

See Also:

StreamLengthParameter(String,int,short,short), StreamLengthParameter(String,int,short)

StreamLengthParameter

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

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

Parameters:

key - The key (String) parameter.

length - The length (int) parameter.

style - The style (short) parameter.

See Also:

StreamLengthParameter(String,int,short,short), StreamLengthParameter(String,int)

Method Detail

getLength

public int getLength()

Gets the length (int) value.

Returns:

The length (int) value.

See Also:

getLength(ParameterCursorService), setLength(int)

getLength

protected int getLength(ParameterCursorService cursor)

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

Overrides:

getLength in class StreamParameter

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get length (int) value.

See Also:

getLength(), setLength(int)

getLengthDefault

public int getLengthDefault()

Gets the length default (int) value.

Returns:

The length default (int) value.

setLength

public void setLength(int length)

Sets the length value.

Parameters:

length - The length (int) parameter.

See Also:

getLength(), getLength(ParameterCursorService)