biz.onixs.sbe

Class DecoderSettings

java.lang.Object

biz.onixs.sbe.DecoderSettings

public class DecoderSettings
extends Object

Settings for decoder.

Constructor Summary

Constructors

Constructor and Description
DecoderSettings()

Method Summary

Modifier and Type	Method and Description
static DecoderSettings	createFullControlSettings() Settings with all checks enabled.
boolean	enableNarrowingOnRead() Checks if the narrowed value validated on write.
boolean	enableNarrowingOnWrite() Checks if the value narrowing enabled on write.
boolean	enableNullDataReturn() Checks if the null value can be returned by field value getter.
Class<?>[]	getCustomCompositeClasses() Custom composite classes.
ClassLoader	getParentLoader() Parent loader for decoder.
DecoderSettings	makeCopy() Makes copy of the settings.
DecoderSettings	setCustomCompositeClasses(Class<?>[] customCompositeClasses) Set custom composite classes.
DecoderSettings	setEnableNarrowingOnRead(boolean enableNarrowingOnRead)
DecoderSettings	setEnableNarrowingOnWrite(boolean enableNarrowingOnWrite) Sets if the value narrowing enabled on write.
DecoderSettings	setEnableNullDataReturn(boolean enableNullDataReturn) Sets option that controls checking of the null data before return.
DecoderSettings	setParentLoader(ClassLoader parentLoader) Sets parent loader for decoder.
DecoderSettings	setValidateNarrowingOnRead(boolean validateNarrowingOnRead) Set narrowing validation on read.
DecoderSettings	setValidateNarrowingOnWrite(boolean validateNarrowingOnWrite) Set narrowing validation on write.
DecoderSettings	setValidateValueRanges(boolean validateValueRanges) Controls raising of exceptions when wrong data occurs.
boolean	validateNarrowingOnRead()
boolean	validateNarrowingOnWrite() Checks if the narrowed value validated on write.
boolean	validateValueRanges() Controls raising of exception when wrong data occurs.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DecoderSettings

public DecoderSettings()

Method Detail

validateValueRanges

public boolean validateValueRanges()

Controls raising of exception when wrong data occurs. This options manages decoder behavior when invalid data occurs on the low level. If the option is true the decoder raises WrongValueException exception when wrong data appear on the wire. If the option is false (default behavior) the data can be read and returned viw accessors.

Returns:

Value of the option.

setValidateValueRanges

public DecoderSettings setValidateValueRanges(boolean validateValueRanges)

Controls raising of exceptions when wrong data occurs.

Parameters:

validateValueRanges - true if exception should be raised.

Returns:

Current instance of the class.

enableNullDataReturn

public boolean enableNullDataReturn()

Checks if the null value can be returned by field value getter. If the option is true getters like to the IFieldSet.getInt(int) can return value that represents empty (or null) data. That is default behaviour of the decoder. If the option is false the NullValueException will be raised by getters. To prevent exceptions the content must be checked using 'tryGet' accessors like to the IFieldSet.tryGetInt(int, AtomicInteger) before access.

Returns:

Value of the option.

setEnableNullDataReturn

public DecoderSettings setEnableNullDataReturn(boolean enableNullDataReturn)

Sets option that controls checking of the null data before return. See the enableNullDataReturn() description for details.

Parameters:

enableNullDataReturn - Value of the option.

Returns:

Current instance of the class.

getParentLoader

public ClassLoader getParentLoader()

Parent loader for decoder. Returns parent loader that is used by decoder. The default value is null, it denotes default system class loader.

Returns:

Parent loader.

setParentLoader

public DecoderSettings setParentLoader(ClassLoader parentLoader)

Sets parent loader for decoder.

Parameters:

parentLoader - Parent class loader to use by decoder.

Returns:

Current instance of the class.

getCustomCompositeClasses

public Class<?>[] getCustomCompositeClasses()

Custom composite classes.

Returns:

Array of custom composite classes.

setCustomCompositeClasses

public DecoderSettings setCustomCompositeClasses(Class<?>[] customCompositeClasses)

Set custom composite classes.

Parameters:

customCompositeClasses - Custom composite classes.

Returns:

Current instance of the class.

makeCopy

public DecoderSettings makeCopy()

Makes copy of the settings.

Returns:

Copy of the object.

createFullControlSettings

public static DecoderSettings createFullControlSettings()

Settings with all checks enabled.

Returns:

New instance of the settings with all checks enabled.

enableNarrowingOnWrite

public boolean enableNarrowingOnWrite()

Checks if the value narrowing enabled on write.

Returns:

Boolean value.

setEnableNarrowingOnWrite

public DecoderSettings setEnableNarrowingOnWrite(boolean enableNarrowingOnWrite)

Sets if the value narrowing enabled on write.

Parameters:

enableNarrowingOnWrite - Boolean value.

Returns:

Current instance of the DecoderSettings.

validateNarrowingOnWrite

public boolean validateNarrowingOnWrite()

Checks if the narrowed value validated on write.

Returns:

Boolean value.

setValidateNarrowingOnWrite

public DecoderSettings setValidateNarrowingOnWrite(boolean validateNarrowingOnWrite)

Set narrowing validation on write.

Parameters:

validateNarrowingOnWrite - true to enable the validation, false otherwise.

Returns:

Current instance of the DecoderSettings.

enableNarrowingOnRead

public boolean enableNarrowingOnRead()

Checks if the narrowed value validated on write.

Returns:

true when the validation enabled, false otherwise.

setEnableNarrowingOnRead

public DecoderSettings setEnableNarrowingOnRead(boolean enableNarrowingOnRead)

validateNarrowingOnRead

public boolean validateNarrowingOnRead()

setValidateNarrowingOnRead

public DecoderSettings setValidateNarrowingOnRead(boolean validateNarrowingOnRead)

Set narrowing validation on read.

Parameters:

validateNarrowingOnRead - true to enable the validation, false otherwise.

Returns:

Current instance of the DecoderSettings.