org.eclipse.soda.dk.parameter
Class ParameterCursor

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

All Implemented Interfaces:

ParameterCursorService

Direct Known Subclasses:

ChildParameterCursor

public class ParameterCursor
extends EscObject
implements ParameterCursorService

Version:

1.2.0

Field Summary

protected boolean	insert Define the insert (boolean) field.
protected java.lang.Object	value Define the value (Object) field.

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.ParameterCursorService

SERVICE_NAME

Constructor Summary

ParameterCursor()
Constructs an instance of this class.

ParameterCursor(int messageLength)
Constructs an instance of this class from the specified message length parameter.

ParameterCursor(ParameterCursorService value)
Constructs an instance of this class from the specified value parameter.

Method Summary

int	getCount() Gets the count (int) value.
CountBlockService	getCountBlock() Gets the count block (CountBlockService) value.
ParameterCursorService	getCountCursor() Gets the count cursor (ParameterCursorService) value.
int	getLength() Gets the length (int) value.
LengthBlockService	getLengthBlock() Gets the length block (LengthBlockService) value.
ParameterCursorService	getLengthCursor() Gets the length cursor (ParameterCursorService) value.
int	getMessageLength() Gets the message length (int) value.
int	getOffset() Gets the offset (int) value.
int	getOffsetAbsolute() Gets the offset absolute (int) value.
int	getOffsetDelta() Gets the offset delta (int) value.
ParameterCursorService	getParent() Gets the parent (ParameterCursorService) value.
int	getRemainingLength() Gets the remaining length (int) value.
java.lang.Object	getValue() Gets the value (Object) value.
boolean	isInsert() Gets the insert (boolean) value.
void	setCount(int count) Sets the count value.
void	setCountBlock(CountBlockService countBlock) Sets the count block value.
void	setCountCursor(ParameterCursorService countCursor) Sets the count cursor value.
void	setInsert(boolean insert) Sets the insert value.
void	setLength(int length) Sets the length value.
void	setLengthBlock(LengthBlockService lengthBlock) Sets the length block value.
void	setLengthCursor(ParameterCursorService lengthCursor) Sets the length cursor value.
void	setMessageLength(int messageLength) Sets the message length value.
void	setOffset(int offset) Sets the offset value.
void	setOffsetAbsolute(int offsetAbsolute) Sets the offset absolute value.
void	setOffsetDelta(int offsetDelta) Sets the offset delta value.
void	setParent(ParameterCursorService parent) Sets the parent value.
void	setValue(java.lang.Object value) Sets the value value.
java.lang.String	toString() Returns the string value.
void	updateMessageLength(int length) Update message length with the specified length parameter.

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, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

value

protected java.lang.Object value

Define the value (Object) field.

insert

protected boolean insert

Define the insert (boolean) field.

Constructor Detail

ParameterCursor

public ParameterCursor()

Constructs an instance of this class.

See Also:

ParameterCursor(int), ParameterCursor(ParameterCursorService)

ParameterCursor

public ParameterCursor(int messageLength)

Constructs an instance of this class from the specified message length parameter.

Parameters:

messageLength - The message length (int) parameter.

See Also:

ParameterCursor(), ParameterCursor(ParameterCursorService)

ParameterCursor

public ParameterCursor(ParameterCursorService value)

Constructs an instance of this class from the specified value parameter.

Parameters:

value - The value (ParameterCursorService) parameter.

See Also:

ParameterCursor(), ParameterCursor(int)

Method Detail

getCount

public int getCount()

Gets the count (int) value.

Specified by:

getCount in interface ParameterCursorService

Returns:

The count (int) value.

See Also:

setCount(int)

getCountBlock

public CountBlockService getCountBlock()

Gets the count block (CountBlockService) value.

Specified by:

getCountBlock in interface ParameterCursorService

Returns:

The count block (CountBlockService) value.

See Also:

setCountBlock(CountBlockService)

getCountCursor

public ParameterCursorService getCountCursor()

Gets the count cursor (ParameterCursorService) value.

Specified by:

getCountCursor in interface ParameterCursorService

Returns:

The count cursor (ParameterCursorService) value.

See Also:

setCountCursor(ParameterCursorService)

getLength

public int getLength()

Gets the length (int) value.

Specified by:

getLength in interface ParameterCursorService

Returns:

The length (int) value.

See Also:

getMessageLength(), getRemainingLength(), setLength(int), setMessageLength(int), updateMessageLength(int)

getLengthBlock

public LengthBlockService getLengthBlock()

Gets the length block (LengthBlockService) value.

Specified by:

getLengthBlock in interface ParameterCursorService

Returns:

The length block (LengthBlockService) value.

See Also:

setLengthBlock(LengthBlockService)

getLengthCursor

public ParameterCursorService getLengthCursor()

Gets the length cursor (ParameterCursorService) value.

Specified by:

getLengthCursor in interface ParameterCursorService

Returns:

The length cursor (ParameterCursorService) value.

See Also:

setLengthCursor(ParameterCursorService)

getMessageLength

public int getMessageLength()

Gets the message length (int) value.

Specified by:

getMessageLength in interface ParameterCursorService

Returns:

The message length (int) value.

See Also:

setMessageLength(int), updateMessageLength(int)

getOffset

public int getOffset()

Gets the offset (int) value.

Specified by:

getOffset in interface ParameterCursorService

Returns:

The offset (int) value.

See Also:

setOffset(int)

getOffsetAbsolute

public int getOffsetAbsolute()

Gets the offset absolute (int) value.

Specified by:

getOffsetAbsolute in interface ParameterCursorService

Returns:

The offset absolute (int) value.

See Also:

setOffsetAbsolute(int)

getOffsetDelta

public int getOffsetDelta()

Gets the offset delta (int) value.

Specified by:

getOffsetDelta in interface ParameterCursorService

Returns:

The offset delta (int) value.

See Also:

setOffsetDelta(int)

getParent

public ParameterCursorService getParent()

Gets the parent (ParameterCursorService) value.

Specified by:

getParent in interface ParameterCursorService

Returns:

The parent (ParameterCursorService) value.

See Also:

setParent(ParameterCursorService)

getRemainingLength

public int getRemainingLength()

Gets the remaining length (int) value.

Specified by:

getRemainingLength in interface ParameterCursorService

Returns:

The remaining length (int) value.

getValue

public java.lang.Object getValue()

Gets the value (Object) value.

Returns:

The value (Object) value.

See Also:

setValue(Object)

isInsert

public boolean isInsert()

Gets the insert (boolean) value.

Specified by:

isInsert in interface ParameterCursorService

Returns:

The insert (boolean) value.

See Also:

setInsert(boolean)

setCount

public void setCount(int count)

Sets the count value.

Specified by:

setCount in interface ParameterCursorService

Parameters:

count - The count (int) parameter.

See Also:

getCount()

setCountBlock

public void setCountBlock(CountBlockService countBlock)

Sets the count block value.

Specified by:

setCountBlock in interface ParameterCursorService

Parameters:

countBlock - The count block (CountBlockService) parameter.

See Also:

getCountBlock()

setCountCursor

public void setCountCursor(ParameterCursorService countCursor)

Sets the count cursor value.

Specified by:

setCountCursor in interface ParameterCursorService

Parameters:

countCursor - The count cursor (ParameterCursorService) parameter.

See Also:

getCountCursor()

setInsert

public void setInsert(boolean insert)

Sets the insert value.

Specified by:

setInsert in interface ParameterCursorService

Parameters:

insert - The insert (boolean) parameter.

See Also:

isInsert()

setLength

public void setLength(int length)

Sets the length value.

Specified by:

setLength in interface ParameterCursorService

Parameters:

length - The length (int) parameter.

See Also:

getLength(), getMessageLength(), getRemainingLength(), setMessageLength(int), updateMessageLength(int)

setLengthBlock

public void setLengthBlock(LengthBlockService lengthBlock)

Sets the length block value.

Specified by:

setLengthBlock in interface ParameterCursorService

Parameters:

lengthBlock - The length block (LengthBlockService) parameter.

See Also:

getLengthBlock()

setLengthCursor

public void setLengthCursor(ParameterCursorService lengthCursor)

Sets the length cursor value.

Specified by:

setLengthCursor in interface ParameterCursorService

Parameters:

lengthCursor - The length cursor (ParameterCursorService) parameter.

See Also:

getLengthCursor()

setMessageLength

public void setMessageLength(int messageLength)

Sets the message length value.

Specified by:

setMessageLength in interface ParameterCursorService

Parameters:

messageLength - The message length (int) parameter.

See Also:

getMessageLength(), updateMessageLength(int)

setOffset

public void setOffset(int offset)

Sets the offset value.

Specified by:

setOffset in interface ParameterCursorService

Parameters:

offset - The offset (int) parameter.

See Also:

getOffset()

setOffsetAbsolute

public void setOffsetAbsolute(int offsetAbsolute)

Sets the offset absolute value.

Specified by:

setOffsetAbsolute in interface ParameterCursorService

Parameters:

offsetAbsolute - The offset absolute (int) parameter.

See Also:

getOffsetAbsolute()

setOffsetDelta

public void setOffsetDelta(int offsetDelta)

Sets the offset delta value.

Specified by:

setOffsetDelta in interface ParameterCursorService

Parameters:

offsetDelta - The offset delta (int) parameter.

See Also:

getOffsetDelta()

setParent

public void setParent(ParameterCursorService parent)

Sets the parent value.

Specified by:

setParent in interface ParameterCursorService

Parameters:

parent - The parent (ParameterCursorService) parameter.

See Also:

getParent()

setValue

public void setValue(java.lang.Object value)

Sets the value value.

Parameters:

value - The value (Object) parameter.

See Also:

getValue()

toString

public java.lang.String toString()

Returns the string value.

Overrides:

toString in class EscObject

Returns:

The string (String) value.

See Also:

EscObject.getStaticString(String,String), EscObject.getString(String,String)

updateMessageLength

public void updateMessageLength(int length)

Update message length with the specified length parameter.

Specified by:

updateMessageLength in interface ParameterCursorService

Parameters:

length - The length (int) parameter.

See Also:

getMessageLength(), setMessageLength(int)