org.eclipse.soda.dk.parameter
Class BooleanParameter

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

All Implemented Interfaces:

DataParameterService, ParameterService

public class BooleanParameter
extends SimpleBooleanParameter

Version:

1.2.0

Field Summary

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

BOOLEAN_LENGTH, FALSE_VALUE, TRUE_VALUE

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

key

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

BIT_MASKS, 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

BooleanParameter()
Constructs an instance of this class.

BooleanParameter(java.lang.String key)
Constructs an instance of this class from the specified key parameter.

BooleanParameter(java.lang.String key, int length)
Constructs an instance of this class from the specified length parameter.

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

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

Method Summary

long	getFalseValue() Gets the false value (long) value.
int	getLength() Gets the length (int) value.
int	getOffset() Gets the offset (int) value.
long	getTrueValue() Gets the true value (long) value.
void	setFalseValue(long falseValue) Sets the false value value.
void	setLength(int length) Sets the length value.
void	setOffset(int offset) Sets the offset value.
void	setTrueValue(long trueValue) Sets the true value value.

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

booleanValue, decodeBytes, encodeBytes, getFalseValueDefault, getTrueValueDefault

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

getKey, setKey

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

createCursorChild, decode, decodeEnd, decodeString, decodeValue, decodeValue, encode, encodeData, encodeString, encodeValue, encodeValue, expand, expand, getAbsoluteOffset, getBytes, getDefaultStyle, getLength, getLittleEndianLong, getLong, getOffsetAbsolute, getOffsetDefault, getOffsetLength, getOffsetValue, getUnsignedInteger, getUnsignedLittleEndianLong, getUnsignedLittleEngianLong, getUnsignedLong, isConstantParameter, isInsert, isInsert, needsCursor, setBits, setBits, setBits, setBitsLittleEngian, setBytes, setBytes, setBytes, setBytesLittleEndian, updateCursor, 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

BooleanParameter

public BooleanParameter(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

See Also:

BooleanParameter(), BooleanParameter(String,int), BooleanParameter(String,int,int), BooleanParameter(String,int,int,long,long)

BooleanParameter

public BooleanParameter()

Constructs an instance of this class.

See Also:

BooleanParameter(String), BooleanParameter(String,int), BooleanParameter(String,int,int), BooleanParameter(String,int,int,long,long)

BooleanParameter

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

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

Parameters:

key - The key (String) parameter.

length - The length (int) parameter.

See Also:

BooleanParameter(String), BooleanParameter(), BooleanParameter(String,int,int), BooleanParameter(String,int,int,long,long)

BooleanParameter

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

BooleanParameter(String), BooleanParameter(), BooleanParameter(String,int), BooleanParameter(String,int,int,long,long)

BooleanParameter

public BooleanParameter(java.lang.String key,
                        int offset,
                        int length,
                        long falseValue,
                        long trueValue)

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

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

falseValue - The false value (long) parameter.

trueValue - The true value (long) parameter.

See Also:

BooleanParameter(String), BooleanParameter(), BooleanParameter(String,int), BooleanParameter(String,int,int)

Method Detail

getFalseValue

public long getFalseValue()

Gets the false value (long) value.

Overrides:

getFalseValue in class SimpleBooleanParameter

Returns:

The false value (long) value.

See Also:

setFalseValue(long)

getLength

public int getLength()

Gets the length (int) value.

Overrides:

getLength in class SimpleBooleanParameter

Returns:

The length (int) value.

See Also:

setLength(int)

getOffset

public int getOffset()

Gets the offset (int) value.

Overrides:

getOffset in class BaseParameter

Returns:

The offset (int) value.

See Also:

setOffset(int)

getTrueValue

public long getTrueValue()

Gets the true value (long) value.

Overrides:

getTrueValue in class SimpleBooleanParameter

Returns:

The true value (long) value.

See Also:

setTrueValue(long)

setFalseValue

public void setFalseValue(long falseValue)

Sets the false value value.

Parameters:

falseValue - The false value (long) parameter.

See Also:

getFalseValue()

setLength

public void setLength(int length)

Sets the length value.

Parameters:

length - The length (int) parameter.

See Also:

getLength()

setOffset

public void setOffset(int offset)

Sets the offset value.

Parameters:

offset - The offset (int) parameter.

See Also:

getOffset()

setTrueValue

public void setTrueValue(long trueValue)

Sets the true value value.

Parameters:

trueValue - The true value (long) parameter.

See Also:

getTrueValue()