2009-01-09 1.2.0

org.eclipse.soda.dk.block
Class CountBlock

java.lang.Object
  extended by org.eclipse.soda.dk.core.EscObject
      extended by org.eclipse.soda.dk.parameter.BaseParameter
          extended by org.eclipse.soda.dk.parameter.BaseKeyParameter
              extended by org.eclipse.soda.dk.parameter.NumberParameter
                  extended by org.eclipse.soda.dk.parameter.SimpleIntegerParameter
                      extended by org.eclipse.soda.dk.parameter.IntegerParameter
                          extended by org.eclipse.soda.dk.block.CountBlock
All Implemented Interfaces:
DataParameterService, BlockService, CountBlockService, ParameterService

public class CountBlock
extends IntegerParameter
implements BlockService, CountBlockService

Version:
1.2.0

Field Summary
 
Fields inherited from class org.eclipse.soda.dk.parameter.SimpleIntegerParameter
INTEGER_LENGTH
 
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.CountBlockService
SERVICE_NAME
 
Constructor Summary
CountBlock()
          Constructs an instance of this class.
CountBlock(int length)
          Constructs an instance of this class from the specified length parameter.
CountBlock(java.lang.String key)
          Constructs an instance of this class from the specified key parameter.
CountBlock(java.lang.String key, int length)
          Constructs an instance of this class from the specified key and length parameters.
CountBlock(java.lang.String key, int offset, int length)
          Constructs an instance of this class from the specified key, offset 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.
 int getCorrectCount(int count)
          Get correct count with the specified count parameter and return the int result.
 boolean isConstantParameter()
          Gets the constant parameter (boolean) value.
protected  int updateCount(int length)
          Update count with the specified length parameter and return the int result.
protected  void updateCursor(ParameterCursorService cursor)
          Update cursor with the specified cursor parameter.
 
Methods inherited from class org.eclipse.soda.dk.parameter.IntegerParameter
getLength, getOffset, setLength, setOffset
 
Methods inherited from class org.eclipse.soda.dk.parameter.NumberParameter
longValue
 
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, isInsert, isInsert, needsCursor, setBits, setBits, setBits, setBitsLittleEngian, setBytes, setBytes, setBytes, setBytesLittleEndian, 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

CountBlock

public CountBlock()
Constructs an instance of this class.

See Also:
CountBlock(int), CountBlock(String), CountBlock(String,int), CountBlock(String,int,int)

CountBlock

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

Parameters:
length - The length (int) parameter.
See Also:
CountBlock(), CountBlock(String), CountBlock(String,int), CountBlock(String,int,int)

CountBlock

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

Parameters:
key - The key (String) parameter.
See Also:
CountBlock(), CountBlock(int), CountBlock(String,int), CountBlock(String,int,int)

CountBlock

public CountBlock(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:
CountBlock(), CountBlock(int), CountBlock(String), CountBlock(String,int,int)

CountBlock

public CountBlock(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:
CountBlock(), CountBlock(int), CountBlock(String), CountBlock(String,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 SimpleIntegerParameter
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 NumberParameter
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)

getCorrectCount

public int getCorrectCount(int count)
Get correct count with the specified count parameter and return the int result.

Parameters:
count - The count (int) parameter.
Returns:
Results of the get correct count (int) value.

isConstantParameter

public boolean isConstantParameter()
Gets the constant parameter (boolean) value.

Specified by:
isConstantParameter in interface ParameterService
Overrides:
isConstantParameter in class BaseParameter
Returns:
The constant parameter (boolean) value.

updateCount

protected int updateCount(int length)
Update count with the specified length parameter and return the int result.

Parameters:
length - The length (int) parameter.
Returns:
Results of the update count (int) value.
See Also:
getCorrectCount(int)

updateCursor

protected void updateCursor(ParameterCursorService cursor)
Update cursor with the specified cursor parameter.

Overrides:
updateCursor in class BaseParameter
Parameters:
cursor - The cursor (ParameterCursorService) parameter.
See Also:
BaseParameter.needsCursor(), BaseParameter.updateCursor(ParameterCursorService,int)

2009-01-09 1.2.0

Copyright (c) 2009 IBM. See license in Legal section.