org.eclipse.soda.dk.parameter
Class StringParameter

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

All Implemented Interfaces:

DataParameterService, ParameterService

Direct Known Subclasses:

BooleanStringParameter, NumberStringParameter

public class StringParameter
extends BaseKeyParameter

Version:

1.2.0

Field Summary

protected java.lang.String

encoding Define the encoding (String) field.

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

StringParameter()
Constructs an instance of this class.

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

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

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

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

Method Summary

java.lang.String	dataToString(java.lang.Object data) Data to string with the specified data parameter and return the String result.
java.lang.Object	decodeBytes(byte[] bytes, ParameterCursorService cursor) Decode bytes with the specified bytes and cursor parameters and return the Object result.
byte[]	encodeBytes(byte[] bytes, java.lang.Object data, ParameterCursorService cursor) Encode bytes with the specified bytes, data and cursor parameters and return the byte[] result.
java.lang.String	getEncoding() Gets the encoding (String) value.
int	getLength() Gets the length (int) value.
int	getOffset() Gets the offset (int) value.
void	setEncoding(java.lang.String encoding) Sets the encoding value.
void	setLength(int length) Sets the length value.
void	setOffset(int offset) Sets the offset 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, 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

encoding

protected java.lang.String encoding

Define the encoding (String) field.

Constructor Detail

StringParameter

public StringParameter()

Constructs an instance of this class.

See Also:

StringParameter(String,int), StringParameter(String,int,int), StringParameter(String,int,int,String), StringParameter(String,int,String)

StringParameter

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

StringParameter(), StringParameter(String,int,int), StringParameter(String,int,int,String), StringParameter(String,int,String)

StringParameter

public StringParameter(java.lang.String key,
                       int offset,
                       int length)

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.

See Also:

StringParameter(), StringParameter(String,int), StringParameter(String,int,int,String), StringParameter(String,int,String)

StringParameter

public StringParameter(java.lang.String key,
                       int offset,
                       int length,
                       java.lang.String encoding)

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

Parameters:

key - The key (String) parameter.

offset - The offset (int) parameter.

length - The length (int) parameter.

encoding - The encoding (String) parameter.

See Also:

StringParameter(), StringParameter(String,int), StringParameter(String,int,int), StringParameter(String,int,String)

StringParameter

public StringParameter(java.lang.String key,
                       int length,
                       java.lang.String encoding)

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

Parameters:

key - The key (String) parameter.

length - The length (int) parameter.

encoding - The encoding (String) parameter.

See Also:

StringParameter(), StringParameter(String,int), StringParameter(String,int,int), StringParameter(String,int,int,String)

Method Detail

dataToString

public java.lang.String dataToString(java.lang.Object data)

Data to string with the specified data parameter and return the String result.

Parameters:

data - The data (Object) parameter.

Returns:

Results of the data to string (String) value.

decodeBytes

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

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

Overrides:

decodeBytes in class BaseParameter

Parameters:

bytes - The bytes (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[] bytes,
                          java.lang.Object data,
                          ParameterCursorService cursor)

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

Overrides:

encodeBytes in class BaseParameter

Parameters:

bytes - The bytes (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)

getEncoding

public java.lang.String getEncoding()

Gets the encoding (String) value.

Returns:

The encoding (String) value.

See Also:

setEncoding(String)

getLength

public int getLength()

Gets the length (int) value.

Overrides:

getLength in class BaseParameter

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)

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the encoding value.

Parameters:

encoding - The encoding (String) parameter.

See Also:

getEncoding()

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()