org.eclipse.soda.dk.segment
Class OptionalSegment

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.segment.SimpleSegment
                  org.eclipse.soda.dk.segment.OptionalSegment

All Implemented Interfaces:

DataParameterService, ParameterService, SegmentService

Direct Known Subclasses:

MultiSegment

public class OptionalSegment
extends SimpleSegment

Version:

1.2.0

Field Summary

Fields inherited from class org.eclipse.soda.dk.segment.SimpleSegment

SEGMENT_NAME

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

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

OptionalSegment()
Constructs an instance of this class.

OptionalSegment(byte[] bytes, FilterService filter, ParameterService parameter)
Constructs an instance of this class from the specified bytes, filter and parameter parameters.

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

OptionalSegment(java.lang.String key, byte[] bytes, FilterService filter, ParameterService parameter)
Constructs an instance of this class from the specified key, bytes, filter and parameter parameters.

Method Summary

void	getDidNotMatch(MessageService message, byte[] compareBytes, ParameterCursorService cursor) Get did not match with the specified message, compare bytes and cursor parameters.
boolean	isInsert() Gets the insert (boolean) value.

Methods inherited from class org.eclipse.soda.dk.segment.SimpleSegment

checkMatches, decodeValue, encodeValue, getBytes, getFilter, getParameter, needsCursor, setBytes, setFilter, setParameter

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

getKey, setKey

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

createCursorChild, decode, decodeBytes, decodeEnd, decodeString, decodeValue, encode, encodeBytes, encodeData, encodeString, encodeValue, expand, expand, getAbsoluteOffset, getBytes, getDefaultStyle, getLength, getLength, getLittleEndianLong, getLong, getOffset, getOffsetAbsolute, getOffsetDefault, getOffsetLength, getOffsetValue, getUnsignedInteger, getUnsignedLittleEndianLong, getUnsignedLittleEngianLong, getUnsignedLong, isConstantParameter, isInsert, 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, encodeValue, getKey, isConstantParameter

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

decode, encode

Constructor Detail

OptionalSegment

public OptionalSegment(java.lang.String key,
                       byte[] bytes,
                       FilterService filter,
                       ParameterService parameter)

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

Parameters:

key - The key (String) parameter.

bytes - The bytes (byte[]) parameter.

filter - The filter (FilterService) parameter.

parameter - The parameter (ParameterService) parameter.

See Also:

OptionalSegment(String), OptionalSegment(), OptionalSegment(byte[],FilterService,ParameterService)

OptionalSegment

public OptionalSegment(java.lang.String key)

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

Parameters:

key - The key (String) parameter.

See Also:

OptionalSegment(String,byte[],FilterService,ParameterService), OptionalSegment(), OptionalSegment(byte[],FilterService,ParameterService)

OptionalSegment

public OptionalSegment()

Constructs an instance of this class.

See Also:

OptionalSegment(String,byte[],FilterService,ParameterService), OptionalSegment(String), OptionalSegment(byte[],FilterService,ParameterService)

OptionalSegment

public OptionalSegment(byte[] bytes,
                       FilterService filter,
                       ParameterService parameter)

Constructs an instance of this class from the specified bytes, filter and parameter parameters.

Parameters:

bytes - The bytes (byte[]) parameter.

filter - The filter (FilterService) parameter.

parameter - The parameter (ParameterService) parameter.

See Also:

OptionalSegment(String,byte[],FilterService,ParameterService), OptionalSegment(String), OptionalSegment()

Method Detail

getDidNotMatch

public void getDidNotMatch(MessageService message,
                           byte[] compareBytes,
                           ParameterCursorService cursor)

Get did not match with the specified message, compare bytes and cursor parameters.

Overrides:

getDidNotMatch in class SimpleSegment

Parameters:

message - The message (MessageService) parameter.

compareBytes - The compare bytes (byte[]) parameter.

cursor - The cursor (ParameterCursorService) parameter.

isInsert

public boolean isInsert()

Gets the insert (boolean) value.

Overrides:

isInsert in class BaseParameter

Returns:

The insert (boolean) value.

See Also:

BaseParameter.isInsert(ParameterCursorService)