org.eclipse.soda.dk.block
Class BytesBlock

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.Block
                  org.eclipse.soda.dk.block.BytesBlock

All Implemented Interfaces:

DataParameterService, BlockService, ParameterService

Direct Known Subclasses:

ConstantBlock, IdentifierBlock, ReserveBlock, TypeBlock, VersionBlock

public class BytesBlock
extends Block

Version:

1.2.0

Field Summary

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

SERVICE_NAME

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, SHORT, STRING, UNLIMITED, UNSIGNED, USE_CURSOR, USE_CURSOR_INSERT

Constructor Summary

BytesBlock()
Constructs an instance of this class.

BytesBlock(byte[] bytes)
Constructs an instance of this class from the specified bytes parameter.

BytesBlock(byte[] bytes, int length)
Constructs an instance of this class from the specified bytes and length parameters.

BytesBlock(int length)
Constructs an instance of this class from the specified length parameter.

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

BytesBlock(java.lang.String key, byte[] bytes, int length)
Constructs an instance of this class from the specified key, bytes and length parameters.

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

Method Summary

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.
byte[]	getBytes() Gets the bytes (byte[]) value.
int	getLength() Gets the length (int) value.
void	setBytes(byte[] bytes) Sets the bytes value.
void	setLength(int length) Sets the length value.

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

isConstantParameter

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

Methods inherited from interface org.eclipse.soda.dk.parameter.service.ParameterService

decodeValue, decodeValue, encodeValue, encodeValue, getKey

Methods inherited from interface org.eclipse.soda.dk.data.parameter.service.DataParameterService

decode, encode

Constructor Detail

BytesBlock

public BytesBlock()

Constructs an instance of this class.

See Also:

BytesBlock(byte[]), BytesBlock(byte[],int), BytesBlock(int), BytesBlock(String), BytesBlock(String,byte[],int), BytesBlock(String,int)

BytesBlock

public BytesBlock(byte[] bytes)

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

Parameters:

bytes - The bytes (byte[]) parameter.

See Also:

BytesBlock(), BytesBlock(byte[],int), BytesBlock(int), BytesBlock(String), BytesBlock(String,byte[],int), BytesBlock(String,int)

BytesBlock

public BytesBlock(byte[] bytes,
                  int length)

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

Parameters:

bytes - The bytes (byte[]) parameter.

length - The length (int) parameter.

See Also:

BytesBlock(), BytesBlock(byte[]), BytesBlock(int), BytesBlock(String), BytesBlock(String,byte[],int), BytesBlock(String,int)

BytesBlock

public BytesBlock(int length)

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

Parameters:

length - The length (int) parameter.

See Also:

BytesBlock(), BytesBlock(byte[]), BytesBlock(byte[],int), BytesBlock(String), BytesBlock(String,byte[],int), BytesBlock(String,int)

BytesBlock

public BytesBlock(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

See Also:

BytesBlock(), BytesBlock(byte[]), BytesBlock(byte[],int), BytesBlock(int), BytesBlock(String,byte[],int), BytesBlock(String,int)

BytesBlock

public BytesBlock(java.lang.String key,
                  byte[] bytes,
                  int length)

Constructs an instance of this class from the specified key, bytes and length parameters.

Parameters:

key - The key (String) parameter.

bytes - The bytes (byte[]) parameter.

length - The length (int) parameter.

See Also:

BytesBlock(), BytesBlock(byte[]), BytesBlock(byte[],int), BytesBlock(int), BytesBlock(String), BytesBlock(String,int)

BytesBlock

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

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

Parameters:

key - The key (String) parameter.

length - The length (int) parameter.

See Also:

BytesBlock(), BytesBlock(byte[]), BytesBlock(byte[],int), BytesBlock(int), BytesBlock(String), BytesBlock(String,byte[],int)

Method Detail

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), getBytes(), setBytes(byte[])

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), getBytes(), setBytes(byte[])

getBytes

public byte[] getBytes()

Gets the bytes (byte[]) value.

Returns:

The bytes (byte[]) value.

See Also:

decodeBytes(byte[],ParameterCursorService), encodeBytes(byte[],Object,ParameterCursorService), setBytes(byte[])

getLength

public int getLength()

Gets the length (int) value.

Overrides:

getLength in class BaseParameter

Returns:

The length (int) value.

See Also:

setLength(int)

setBytes

public void setBytes(byte[] bytes)

Sets the bytes value.

Parameters:

bytes - The bytes (byte[]) parameter.

See Also:

decodeBytes(byte[],ParameterCursorService), encodeBytes(byte[],Object,ParameterCursorService), getBytes()

setLength

public void setLength(int length)

Sets the length value.

Parameters:

length - The length (int) parameter.

See Also:

getLength()