biz.onixs.sbe

Class DecoderSettings

java.lang.Object

biz.onixs.sbe.DecoderSettings

public class DecoderSettings
extends Object

Runtime settings for ByteDecoder and generated message classes.

Constructor Summary

Constructors

Constructor and Description
DecoderSettings()

Method Summary

Modifier and Type	Method and Description
static DecoderSettings	createFullControlSettings() Creates strict preset with all runtime checks enabled.
boolean	enableNarrowingOnRead() Indicates whether narrowing is enabled for read operations.
boolean	enableNarrowingOnWrite() Indicates whether narrowing is enabled for write operations.
boolean	enableNullDataReturn() Indicates whether getters may return null representation for optional SBE fields.
Class<?>[]	getCustomCompositeClasses() Returns classes/interfaces used for custom composite bindings.
ClassLoader	getParentLoader() Returns parent class loader for generated classes.
DecoderSettings	makeCopy() Creates a copy of this settings object.
DecoderSettings	setCustomCompositeClasses(Class<?>[] customCompositeClasses) Sets classes/interfaces used for custom composite bindings.
DecoderSettings	setEnableNarrowingOnRead(boolean enableNarrowingOnRead) Enables or disables narrowing for read operations.
DecoderSettings	setEnableNarrowingOnWrite(boolean enableNarrowingOnWrite) Enables or disables narrowing for write operations.
DecoderSettings	setEnableNullDataReturn(boolean enableNullDataReturn) Enables or disables null data return behavior for optional fields.
DecoderSettings	setParentLoader(ClassLoader parentLoader) Sets parent class loader for generated classes.
DecoderSettings	setValidateNarrowingOnRead(boolean validateNarrowingOnRead) Enables or disables validation for read narrowing.
DecoderSettings	setValidateNarrowingOnWrite(boolean validateNarrowingOnWrite) Enables or disables validation for write narrowing.
DecoderSettings	setValidateValueRanges(boolean validateValueRanges) Enables or disables range validation for values read from or written to message fields.
boolean	validateNarrowingOnRead() Indicates whether read narrowing results are validated.
boolean	validateNarrowingOnWrite() Indicates whether write narrowing results are validated.
boolean	validateValueRanges() Indicates whether decoded values are validated against schema ranges.

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

Indicates whether decoded values are validated against schema ranges.

If enabled, decoder throws WrongValueException when a wire value is outside the schema constraints.

Default value is false.

Returns:

true if range validation is enabled.

setValidateValueRanges

public DecoderSettings setValidateValueRanges(boolean validateValueRanges)

Enables or disables range validation for values read from or written to message fields.

Parameters:

validateValueRanges - true to enable range validation.

Returns:

current settings instance.

enableNullDataReturn

public boolean enableNullDataReturn()

Indicates whether getters may return null representation for optional SBE fields.

If enabled, getters such as IFieldSet.getInt(int) return null-representation values for optional fields that contain SBE null.

If disabled, getters throw NullValueException for such fields. In this mode, use tryGet... methods (for example IFieldSet.tryGetInt(int, AtomicInteger)) to check presence before reading.

Default value is true.

Returns:

true if null data return is enabled.

setEnableNullDataReturn

public DecoderSettings setEnableNullDataReturn(boolean enableNullDataReturn)

Enables or disables null data return behavior for optional fields.

Parameters:

enableNullDataReturn - true to return null-representation values, false to throw on null optional values.

Returns:

current settings instance.

getParentLoader

public ClassLoader getParentLoader()

Returns parent class loader for generated classes.

null means system class loader.

Returns:

parent class loader.

setParentLoader

public DecoderSettings setParentLoader(ClassLoader parentLoader)

Sets parent class loader for generated classes.

Parameters:

parentLoader - parent class loader, or null for system class loader.

Returns:

current settings instance.

getCustomCompositeClasses

public Class<?>[] getCustomCompositeClasses()

Returns classes/interfaces used for custom composite bindings.

Returns:

array of custom composite classes.

setCustomCompositeClasses

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

Sets classes/interfaces used for custom composite bindings.

Parameters:

customCompositeClasses - custom composite classes.

Returns:

current settings instance.

makeCopy

public DecoderSettings makeCopy()

Creates a copy of this settings object.

Returns:

new settings instance with the same values.

createFullControlSettings

public static DecoderSettings createFullControlSettings()

Creates strict preset with all runtime checks enabled.

Returns:

new settings instance for strict validation mode.

enableNarrowingOnWrite

public boolean enableNarrowingOnWrite()

Indicates whether narrowing is enabled for write operations.

Returns:

true if write narrowing is enabled.

setEnableNarrowingOnWrite

public DecoderSettings setEnableNarrowingOnWrite(boolean enableNarrowingOnWrite)

Enables or disables narrowing for write operations.

Parameters:

enableNarrowingOnWrite - true to enable write narrowing.

Returns:

current settings instance.

validateNarrowingOnWrite

public boolean validateNarrowingOnWrite()

Indicates whether write narrowing results are validated.

Returns:

true if write narrowing validation is enabled.

setValidateNarrowingOnWrite

public DecoderSettings setValidateNarrowingOnWrite(boolean validateNarrowingOnWrite)

Enables or disables validation for write narrowing.

Parameters:

validateNarrowingOnWrite - true to validate write narrowing.

Returns:

current settings instance.

enableNarrowingOnRead

public boolean enableNarrowingOnRead()

Indicates whether narrowing is enabled for read operations.

Returns:

true if read narrowing is enabled.

setEnableNarrowingOnRead

public DecoderSettings setEnableNarrowingOnRead(boolean enableNarrowingOnRead)

Enables or disables narrowing for read operations.

Parameters:

enableNarrowingOnRead - true to enable read narrowing.

Returns:

current settings instance.

validateNarrowingOnRead

public boolean validateNarrowingOnRead()

Indicates whether read narrowing results are validated.

Returns:

true if read narrowing validation is enabled.

setValidateNarrowingOnRead

public DecoderSettings setValidateNarrowingOnRead(boolean validateNarrowingOnRead)

Enables or disables validation for read narrowing.

Parameters:

validateNarrowingOnRead - true to validate read narrowing.

Returns:

current settings instance.