org.eclipse.soda.dk.parameter
Class SimpleBooleanParameter

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

All Implemented Interfaces:

DataParameterService, ParameterService

Direct Known Subclasses:

BooleanParameter

public class SimpleBooleanParameter
extends BaseKeyParameter

Version:

1.2.0

Field Summary

static int	BOOLEAN_LENGTH Define the boolean length (int) constant.
static int	FALSE_VALUE Define the false value (int) constant.
static int	TRUE_VALUE Define the true value (int) constant.

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

SimpleBooleanParameter()
Constructs an instance of this class.

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

Method Summary

boolean	booleanValue(java.lang.Object data) Boolean value with the specified data parameter and return the boolean result.
java.lang.Object	decodeBytes(byte[] container, ParameterCursorService cursor) Decode bytes with the specified container and cursor parameters and return the Object result.
byte[]	encodeBytes(byte[] container, java.lang.Object data, ParameterCursorService cursor) Encode bytes with the specified container, data and cursor parameters and return the byte[] result.
long	getFalseValue() Gets the false value (long) value.
long	getFalseValueDefault() Gets the false value default (long) value.
int	getLength() Gets the length (int) value.
long	getTrueValue() Gets the true value (long) value.
long	getTrueValueDefault() Gets the true value default (long) value.

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

Field Detail

FALSE_VALUE

public static final int FALSE_VALUE

Define the false value (int) constant.

See Also:

Constant Field Values

TRUE_VALUE

public static final int TRUE_VALUE

Define the true value (int) constant.

See Also:

Constant Field Values

BOOLEAN_LENGTH

public static final int BOOLEAN_LENGTH

Define the boolean length (int) constant.

See Also:

Constant Field Values

Constructor Detail

SimpleBooleanParameter

public SimpleBooleanParameter()

Constructs an instance of this class.

See Also:

SimpleBooleanParameter(String)

SimpleBooleanParameter

public SimpleBooleanParameter(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

See Also:

SimpleBooleanParameter()

Method Detail

booleanValue

public boolean booleanValue(java.lang.Object data)

Boolean value with the specified data parameter and return the boolean result.

Parameters:

data - The data (Object) parameter.

Returns:

Results of the boolean value (boolean) value.

See Also:

getFalseValue(), getTrueValue()

decodeBytes

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

Decode bytes with the specified container and cursor parameters and return the Object result.

Overrides:

decodeBytes in class BaseParameter

Parameters:

container - The container (byte[]) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

Results of the decode bytes (Object) value.

See Also:

encodeBytes(byte[],Object,ParameterCursorService)

encodeBytes

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

Encode bytes with the specified container, data and cursor parameters and return the byte[] result.

Overrides:

encodeBytes in class BaseParameter

Parameters:

container - The container (byte[]) parameter.

data - The data (Object) parameter.

cursor - The cursor (ParameterCursorService) parameter.

Returns:

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

See Also:

decodeBytes(byte[],ParameterCursorService)

getFalseValue

public long getFalseValue()

Gets the false value (long) value.

Returns:

The false value (long) value.

getFalseValueDefault

public long getFalseValueDefault()

Gets the false value default (long) value.

Returns:

The false value default (long) value.

getLength

public int getLength()

Gets the length (int) value.

Overrides:

getLength in class BaseParameter

Returns:

The length (int) value.

See Also:

BaseParameter.getLength(ParameterCursorService), BaseParameter.getOffsetLength()

getTrueValue

public long getTrueValue()

Gets the true value (long) value.

Returns:

The true value (long) value.

getTrueValueDefault

public long getTrueValueDefault()

Gets the true value default (long) value.

Returns:

The true value default (long) value.