org.eclipse.soda.dk.parameter
Class BaseParameter

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

All Implemented Interfaces:

DataParameterService, ParameterService

Direct Known Subclasses:

BaseKeyParameter

public class BaseParameter
extends EscObject
implements ParameterService

Version:

1.2.0

Field Summary

static int[]	BIT_MASKS Define the bit masks (int[]) constant.
static int[]	MASKS Define the masks (int[]) constant.
static int[]	SET_MASKS Define the set masks (int[]) constant.
static int[]	SET_TOP_MASKS Define the set top masks (int[]) constant.

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

BaseParameter()
Constructs an instance of this class.

Method Summary

ParameterCursorService	createCursorChild(ParameterCursorService parent) Create cursor child with the specified parent parameter and return the ParameterCursorService result.
java.lang.Object	decode(java.lang.Object container) Decode with the specified container parameter and return the Object result.
java.lang.Object	decodeBytes(byte[] container, ParameterCursorService cursor) Decode bytes with the specified container parameter and return the Object result.
java.lang.Object	decodeEnd(java.lang.Object object) Decode end with the specified object parameter and return the Object result.
java.lang.Object	decodeString(java.lang.String container, ParameterCursorService cursor) Decode string with the specified container parameter and return the Object result.
java.lang.Object	decodeValue(MessageService message) Decode value with the specified message parameter and return the Object result.
java.lang.Object	decodeValue(MessageService message, ParameterCursorService cursor) Decode value with the specified message and cursor parameters and return the Object result.
java.lang.Object	encode(java.lang.Object container, java.lang.Object data) Encode with the specified container and data parameters and return the Object result.
byte[]	encodeBytes(byte[] bytes, java.lang.Object data, ParameterCursorService cursor) Encode bytes with the specified container and data parameters and return the Object result.
java.lang.Object	encodeData(java.lang.Object data) Encode data with the specified data parameter and return the Object result.
java.lang.Object	encodeString(java.lang.String container, java.lang.Object data, ParameterCursorService cursor) Encode string with the specified container and data parameters and return the Object result.
MessageService	encodeValue(MessageService message, java.lang.Object value) Encode value with the specified message and value parameters and return the MessageService 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.
static byte[]	expand(byte[] bytes, int offset, int length) Expand with the specified bytes, offset and length parameters and return the byte[] result.
static byte[]	expand(byte[] bytes, int bytesLength, int offset, int length) Expand with the specified bytes, bytes length, offset and length parameters and return the byte[] result.
static int	getAbsoluteOffset(int offset) Get absolute offset with the specified offset parameter and return the int result.
static byte[]	getBytes(byte[] bytes, int offset, int length) Get bytes with the specified bytes, offset and length parameters and return the byte[] result.
static short	getDefaultStyle() Gets the default style (short) value.
java.lang.String	getKey() Gets the key (String) value.
int	getLength() Gets the length (int) value.
protected int	getLength(ParameterCursorService cursor) Get length with the specified cursor parameter and return the int result.
static long	getLittleEndianLong(byte[] bytes, int offset, int length) Get little endian long with the specified bytes, offset and length parameters and return the long result.
static long	getLong(byte[] bytes, int offset, int length) Get long with the specified bytes, offset and length parameters and return the long result.
int	getOffset() Gets the offset (int) value.
protected int	getOffsetAbsolute(ParameterCursorService cursor) Get offset with the specified cursor parameter and return the int result.
int	getOffsetDefault() Gets the offset default (int) value.
int	getOffsetLength() Gets the offset length (int) value.
protected int	getOffsetValue(ParameterCursorService cursor) Get offset value with the specified cursor parameter and return the int result.
static int	getUnsignedInteger(byte[] bytes, int offset, int length) Get unsigned integer with the specified bytes, offset and length parameters and return the long result.
static long	getUnsignedLittleEndianLong(byte[] bytes, int offset, int length) Get unsigned little endian long with the specified bytes, offset and length parameters and return the long result.
static long	getUnsignedLittleEngianLong(byte[] bytes, int offset, int length) Deprecated. #getUnsignedLittleEndianLong
static long	getUnsignedLong(byte[] bytes, int offset, int length) Get unsigned long with the specified bytes, offset and length parameters and return the long result.
boolean	isConstantParameter() Gets the constant parameter (boolean) value.
boolean	isInsert() Gets the insert (boolean) value.
boolean	isInsert(ParameterCursorService cursor) Is insert with the specified cursor parameter and return the boolean result.
boolean	needsCursor() Needs cursor and return the boolean result.
static byte[]	setBits(byte[] bytes, int bytesLength, int offset, int length, long value, boolean insert) Set bits with the specified bytes, bytes length, offset, length, value and insert parameters and return the byte[] result.
static byte[]	setBits(byte[] bytes, int offset, int length, long value) Set bits with the specified bytes, offset, length and value parameters.
static byte[]	setBits(byte[] bytes, int offset, int length, long value, boolean insert) Set bits with the specified bytes, offset, length, value and insert parameters and return the byte[] result.
static byte[]	setBitsLittleEngian(byte[] bytes, int bytesLength, int offset, int length, long value, boolean insert) Set bits little engian with the specified bytes, bytes length, offset, length, value and insert parameters and return the byte[] result.
static byte[]	setBytes(byte[] bytes, int offset, int length, byte[] data) Get bytes with the specified bytes, offset and length parameters and return the byte[] result.
static byte[]	setBytes(byte[] bytes, int offset, int length, byte[] data, boolean insert) Set bytes with the specified bytes, offset, length, data and insert parameters and return the byte[] result.
static byte[]	setBytes(byte[] bytes, int bytesLength, int offset, int length, byte[] data, boolean insert) Set bytes with the specified bytes, bytes length, offset, length, data and insert parameters and return the byte[] result.
static byte[]	setBytesLittleEndian(byte[] bytes, int bytesLength, int offset, int length, byte[] data, boolean insert) Set bytes little endian with the specified bytes, bytes length, offset, length, data and insert parameters and return the byte[] result.
protected void	updateCursor(ParameterCursorService cursor) Update cursor with the specified cursor parameter.
protected void	updateCursor(ParameterCursorService cursor, int length) Update cursor with the specified cursor and length parameters.

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

BIT_MASKS

public static final int[] BIT_MASKS

Define the bit masks (int[]) constant.

MASKS

public static final int[] MASKS

Define the masks (int[]) constant.

SET_MASKS

public static final int[] SET_MASKS

Define the set masks (int[]) constant.

SET_TOP_MASKS

public static final int[] SET_TOP_MASKS

Define the set top masks (int[]) constant.

Constructor Detail

BaseParameter

public BaseParameter()

Constructs an instance of this class.

Method Detail

expand

public static byte[] expand(byte[] bytes,
                            int offset,
                            int length)

Expand with the specified bytes, offset and length parameters and return the byte[] result.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

Results of the expand (byte[]) value.

See Also:

expand(byte[],int,int,int)

expand

public static byte[] expand(byte[] bytes,
                            int bytesLength,
                            int offset,
                            int length)

Expand with the specified bytes, bytes length, offset and length parameters and return the byte[] result.

Parameters:

bytes - The bytes (byte[]) parameter.

bytesLength - The bytes length (int) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

Results of the expand (byte[]) value.

See Also:

expand(byte[],int,int)

getAbsoluteOffset

public static final int getAbsoluteOffset(int offset)

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

Parameters:

offset - The offset (int) parameter.

Returns:

Results of the get absolute offset (int) value.

getBytes

public static byte[] getBytes(byte[] bytes,
                              int offset,
                              int length)

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

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

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

See Also:

setBytes(byte[],int,int,byte[]), setBytes(byte[],int,int,byte[],boolean), setBytes(byte[],int,int,int,byte[],boolean), decodeBytes(byte[],ParameterCursorService), encodeBytes(byte[],Object,ParameterCursorService)

getDefaultStyle

public static short getDefaultStyle()

Gets the default style (short) value.

Returns:

The default style (short) value.

getLittleEndianLong

public static long getLittleEndianLong(byte[] bytes,
                                       int offset,
                                       int length)

Get little endian long with the specified bytes, offset and length parameters and return the long result.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

Results of the get little endian long (long) value.

See Also:

getUnsignedLittleEndianLong(byte[],int,int)

getLong

public static long getLong(byte[] bytes,
                           int offset,
                           int length)

Get long with the specified bytes, offset and length parameters and return the long result.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

Results of the get long (long) value.

See Also:

getLittleEndianLong(byte[],int,int), getUnsignedLittleEndianLong(byte[],int,int), getUnsignedLittleEngianLong(byte[],int,int), getUnsignedLong(byte[],int,int)

getUnsignedInteger

public static int getUnsignedInteger(byte[] bytes,
                                     int offset,
                                     int length)

Get unsigned integer with the specified bytes, offset and length parameters and return the long result.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

Results of the get unsigned long (long) value.

Since:

1.2

getUnsignedLittleEndianLong

public static long getUnsignedLittleEndianLong(byte[] bytes,
                                               int offset,
                                               int length)

Get unsigned little endian long with the specified bytes, offset and length parameters and return the long result.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

Results of the get unsigned little endian long (long) value.

Since:

1.2

getUnsignedLittleEngianLong

public static long getUnsignedLittleEngianLong(byte[] bytes,
                                               int offset,
                                               int length)

Deprecated. #getUnsignedLittleEndianLong

Get unsigned little endian long with the specified bytes, offset and length parameters and return the long result.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

Results of the get unsigned little endian long (long) value.

getUnsignedLong

public static long getUnsignedLong(byte[] bytes,
                                   int offset,
                                   int length)

Get unsigned long with the specified bytes, offset and length parameters and return the long result.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

Returns:

Results of the get unsigned long (long) value.

setBits

public static byte[] setBits(byte[] bytes,
                             int bytesLength,
                             int offset,
                             int length,
                             long value,
                             boolean insert)

Set bits with the specified bytes, bytes length, offset, length, value and insert parameters and return the byte[] result.

Parameters:

bytes - The bytes (byte[]) parameter.

bytesLength - The bytes length (int) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

value - The value (long) parameter.

insert - The insert (boolean) parameter.

Returns:

Results of the set bits (byte[]) value.

See Also:

setBits(byte[],int,int,long), setBits(byte[],int,int,long,boolean)

setBits

public static byte[] setBits(byte[] bytes,
                             int offset,
                             int length,
                             long value)

Set bits with the specified bytes, offset, length and value parameters.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

value - The value (long) parameter.

Returns:

Results of the set bits (byte[]) value.

See Also:

setBits(byte[],int,int,int,long,boolean), setBits(byte[],int,int,long,boolean)

setBits

public static byte[] setBits(byte[] bytes,
                             int offset,
                             int length,
                             long value,
                             boolean insert)

Set bits with the specified bytes, offset, length, value and insert parameters and return the byte[] result.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

value - The value (long) parameter.

insert - The insert (boolean) parameter.

Returns:

Results of the set bits (byte[]) value.

See Also:

setBits(byte[],int,int,int,long,boolean), setBits(byte[],int,int,long)

setBitsLittleEngian

public static byte[] setBitsLittleEngian(byte[] bytes,
                                         int bytesLength,
                                         int offset,
                                         int length,
                                         long value,
                                         boolean insert)

Set bits little engian with the specified bytes, bytes length, offset, length, value and insert parameters and return the byte[] result.

Parameters:

bytes - The bytes (byte[]) parameter.

bytesLength - The bytes length (int) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

value - The value (long) parameter.

insert - The insert (boolean) parameter.

Returns:

Results of the set bits little engian (byte[]) value.

setBytes

public static byte[] setBytes(byte[] bytes,
                              int offset,
                              int length,
                              byte[] data)

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

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

data - The data (byte[]) parameter.

Returns:

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

See Also:

getBytes(byte[],int,int), setBytes(byte[],int,int,byte[],boolean), setBytes(byte[],int,int,int,byte[],boolean), decodeBytes(byte[],ParameterCursorService), encodeBytes(byte[],Object,ParameterCursorService)

setBytes

public static byte[] setBytes(byte[] bytes,
                              int offset,
                              int length,
                              byte[] data,
                              boolean insert)

Set bytes with the specified bytes, offset, length, data and insert parameters and return the byte[] result.

Parameters:

bytes - The bytes (byte[]) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

data - The data (byte[]) parameter.

insert - The insert (boolean) parameter.

Returns:

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

See Also:

getBytes(byte[],int,int), setBytes(byte[],int,int,byte[]), setBytes(byte[],int,int,int,byte[],boolean), decodeBytes(byte[],ParameterCursorService), encodeBytes(byte[],Object,ParameterCursorService)

setBytes

public static byte[] setBytes(byte[] bytes,
                              int bytesLength,
                              int offset,
                              int length,
                              byte[] data,
                              boolean insert)

Set bytes with the specified bytes, bytes length, offset, length, data and insert parameters and return the byte[] result.

Parameters:

bytes - The bytes (byte[]) parameter.

bytesLength - The bytes length (int) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

data - The data (byte[]) parameter.

insert - The insert (boolean) parameter.

Returns:

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

See Also:

getBytes(byte[],int,int), setBytes(byte[],int,int,byte[]), setBytes(byte[],int,int,byte[],boolean), decodeBytes(byte[],ParameterCursorService), encodeBytes(byte[],Object,ParameterCursorService)

setBytesLittleEndian

public static byte[] setBytesLittleEndian(byte[] bytes,
                                          int bytesLength,
                                          int offset,
                                          int length,
                                          byte[] data,
                                          boolean insert)

Set bytes little endian with the specified bytes, bytes length, offset, length, data and insert parameters and return the byte[] result.

Parameters:

bytes - The bytes (byte[]) parameter.

bytesLength - The bytes length (int) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

data - The data (byte[]) parameter.

insert - The insert (boolean) parameter.

Returns:

Results of the set bytes little endian (byte[]) value.

createCursorChild

public ParameterCursorService createCursorChild(ParameterCursorService parent)

Create cursor child with the specified parent parameter and return the ParameterCursorService result.

Parameters:

parent - The parent (ParameterCursorService) parameter.

Returns:

Results of the create cursor child (ParameterCursorService) value.

decode

public java.lang.Object decode(java.lang.Object container)

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

Specified by:

decode in interface DataParameterService

Parameters:

container - The container (Object) parameter.

Returns:

Results of the decode (Object) value.

decodeBytes

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

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

Parameters:

container - The container (byte[]) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode bytes (Object) value.

See Also:

getBytes(byte[],int,int), setBytes(byte[],int,int,byte[]), setBytes(byte[],int,int,byte[],boolean), setBytes(byte[],int,int,int,byte[],boolean), encodeBytes(byte[],Object,ParameterCursorService)

decodeEnd

public java.lang.Object decodeEnd(java.lang.Object object)

Decode end with the specified object parameter and return the Object result.

Parameters:

object - The object (Object) parameter.

Returns:

Results of the decode end (Object) value.

decodeString

public java.lang.Object decodeString(java.lang.String container,
                                     ParameterCursorService cursor)

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

Parameters:

container - The container (String) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode string (Object) value.

See Also:

encodeString(String,Object,ParameterCursorService)

decodeValue

public java.lang.Object decodeValue(MessageService message)

Decode value with the specified message parameter and return the Object result.

Specified by:

decodeValue in interface ParameterService

Parameters:

message - The message (MessageService) parameter.

Returns:

Results of the decode value (Object) value.

See Also:

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

decodeValue

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

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

Specified by:

decodeValue in interface ParameterService

Parameters:

message - The message (MessageService) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode value (Object) value.

See Also:

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

encode

public java.lang.Object encode(java.lang.Object container,
                               java.lang.Object data)

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

Specified by:

encode in interface DataParameterService

Parameters:

container - The container (Object) parameter.

data - The data (Object) parameter.

Returns:

Results of the encode (Object) value.

encodeBytes

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

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

Parameters:

bytes - The bytes (byte[]) parameter.

data - The data (Object) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the encode bytes (Object) value.

See Also:

getBytes(byte[],int,int), setBytes(byte[],int,int,byte[]), setBytes(byte[],int,int,byte[],boolean), setBytes(byte[],int,int,int,byte[],boolean), decodeBytes(byte[],ParameterCursorService)

encodeData

public java.lang.Object encodeData(java.lang.Object data)

Encode data with the specified data parameter and return the Object result.

Parameters:

data - The data (Object) parameter.

Returns:

Results of the encode data (Object) value.

encodeString

public java.lang.Object encodeString(java.lang.String container,
                                     java.lang.Object data,
                                     ParameterCursorService cursor)

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

Parameters:

container - The container (String) parameter.

data - The data (Object) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the encode string (Object) value.

See Also:

decodeString(String,ParameterCursorService)

encodeValue

public MessageService encodeValue(MessageService message,
                                  java.lang.Object value)

Encode value with the specified message and value parameters and return the MessageService result.

Specified by:

encodeValue in interface ParameterService

Parameters:

message - The message (MessageService) parameter.

value - The value (Object) parameter.

Returns:

Results of the encode value (MessageService) value.

See Also:

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

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

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), decodeValue(MessageService,ParameterCursorService), encodeValue(MessageService,Object), getOffsetValue(ParameterCursorService)

getKey

public java.lang.String getKey()

Gets the key (String) value.

Specified by:

getKey in interface ParameterService

Returns:

The key (String) value.

getLength

public int getLength()

Gets the length (int) value.

Returns:

The length (int) value.

See Also:

getLength(ParameterCursorService), getOffsetLength()

getLength

protected int getLength(ParameterCursorService cursor)

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

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get length (int) value.

See Also:

getLength(), getOffsetLength()

getOffset

public int getOffset()

Gets the offset (int) value.

Returns:

The offset (int) value.

See Also:

getAbsoluteOffset(int)

getOffsetAbsolute

protected int getOffsetAbsolute(ParameterCursorService cursor)

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

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get offset (int) value.

getOffsetDefault

public int getOffsetDefault()

Gets the offset default (int) value.

Returns:

The offset default (int) value.

getOffsetLength

public int getOffsetLength()

Gets the offset length (int) value.

Returns:

The offset length (int) value.

getOffsetValue

protected int getOffsetValue(ParameterCursorService cursor)

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

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the get offset value (int) value.

isConstantParameter

public boolean isConstantParameter()

Gets the constant parameter (boolean) value.

Specified by:

isConstantParameter in interface ParameterService

Returns:

The constant parameter (boolean) value.

isInsert

public boolean isInsert()

Gets the insert (boolean) value.

Returns:

The insert (boolean) value.

See Also:

isInsert(ParameterCursorService)

isInsert

public boolean isInsert(ParameterCursorService cursor)

Is insert with the specified cursor parameter and return the boolean result.

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the is insert (boolean) value.

See Also:

isInsert()

needsCursor

public boolean needsCursor()

Needs cursor and return the boolean result.

Returns:

Results of the needs cursor (boolean) value.

See Also:

updateCursor(ParameterCursorService), updateCursor(ParameterCursorService,int)

updateCursor

protected void updateCursor(ParameterCursorService cursor)

Update cursor with the specified cursor parameter.

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

See Also:

needsCursor(), updateCursor(ParameterCursorService,int)

updateCursor

protected void updateCursor(ParameterCursorService cursor,
                            int length)

Update cursor with the specified cursor and length parameters.

Parameters:

cursor - The cursor (ParameterCursorService) parameter.

length - The length (int) parameter.

See Also:

needsCursor(), updateCursor(ParameterCursorService)