org.eclipse.soda.dk.parameter
Class BaseKeyParameter

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

All Implemented Interfaces:

DataParameterService, ParameterService

Direct Known Subclasses:

Block, BytesParameter, MultiParameter, NumberParameter, SimpleBooleanParameter, SimpleSegment, StringParameter, Utf8StringParameter

public class BaseKeyParameter
extends BaseParameter

Version:

1.2.0

Field Summary

protected java.lang.String

key Define the key (String) field.

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

BaseKeyParameter()
Constructs an instance of this class.

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

Method Summary

java.lang.String	getKey() Gets the key (String) value.
void	setKey(java.lang.String key) Sets the key value.

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

createCursorChild, decode, decodeBytes, decodeEnd, decodeString, decodeValue, decodeValue, encode, encodeBytes, encodeData, encodeString, encodeValue, encodeValue, expand, expand, getAbsoluteOffset, getBytes, getDefaultStyle, getLength, 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

key

protected java.lang.String key

Define the key (String) field.

Constructor Detail

BaseKeyParameter

public BaseKeyParameter()

Constructs an instance of this class.

See Also:

BaseKeyParameter(String)

BaseKeyParameter

public BaseKeyParameter(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

See Also:

BaseKeyParameter()

Method Detail

getKey

public java.lang.String getKey()

Gets the key (String) value.

Specified by:

getKey in interface ParameterService

Overrides:

getKey in class BaseParameter

Returns:

The key (String) value.

See Also:

setKey(String)

setKey

public void setKey(java.lang.String key)

Sets the key value.

Parameters:

key - The key (String) parameter.

See Also:

getKey()