biz.onixs.sbe

Class FramingHeaderPolicy

java.lang.Object

biz.onixs.sbe.FramingHeaderPolicy

public class FramingHeaderPolicy
extends Object

Policy of SBE framing header using.

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFH_POLICY_OVERRIDE_SCHEMA_FRAMING_HEADER Override schema framing header specification.
static int	OFH_POLICY_USE_BIG_ENDIAN Use big endian for template-specified framing header.
static int	OFH_POLICY_USE_LITTLE_ENDIAN Use little endian for template-specified framing header.
static int	OFH_POLICY_USE_SCHEMA_ENDIANESS Use template-specified endianess.
static FramingHeaderPolicy	UseBigEndian Override standard endianess with big endian.
static FramingHeaderPolicy	UseLittleEndian Override standard endianess with little endian.
static FramingHeaderPolicy	UseSchemaByStandard Default policy.
static FramingHeaderPolicy	UseSchemaEndianess Override standard endianess with the schema-specified one.

Constructor Summary

Constructors

Constructor and Description
FramingHeaderPolicy(FramingHeaderPolicy src) Makes a copy of the policy.
FramingHeaderPolicy(FramingHeaderSpecification specification, int flags) Constructs new instance of the policy.

Method Summary

Modifier and Type	Method and Description
static FramingHeaderPolicy	getCustomPolicy(FramingHeaderSpecification specification) Override standard or schema-specified framing header with the custom one.
int	getFlags() The policy flags.
FramingHeaderSpecification	getSpecification() Custom specification.

Methods inherited from class java.lang.Object

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

Field Detail

OFH_POLICY_USE_SCHEMA_ENDIANESS

public static final int OFH_POLICY_USE_SCHEMA_ENDIANESS

Use template-specified endianess.

The default endianess for SBE framing header is Big Endian. But in particular cases the framing header should use the endianess specified in the template itself (usually it is Little Endian). The flag should be used in such cases.

Note: The flag ignored if the OFH_POLICY_OVERRIDE_SCHEMA_FRAMING_HEADER is used. Alos, it can not be used with OFH_POLICY_USE_LITTLE_ENDIAN or OFH_POLICY_USE_BIG_ENDIAN flags.

See Also:

Constant Field Values

OFH_POLICY_USE_LITTLE_ENDIAN

public static final int OFH_POLICY_USE_LITTLE_ENDIAN

Use little endian for template-specified framing header.

When the flag is set the framing header specification restored from the template will be forced to use the little endian to encode.

The flag ignored if the OFH_POLICY_OVERRIDE_SCHEMA_FRAMING_HEADER is used. Also, it can not be used with OFH_POLICY_USE_SCHEMA_ENDIANESS or OFH_POLICY_USE_BIG_ENDIAN flags.

See Also:

Constant Field Values

OFH_POLICY_USE_BIG_ENDIAN

public static final int OFH_POLICY_USE_BIG_ENDIAN

Use big endian for template-specified framing header.

When the flag is set the framing header specification restored from the template will be forced to use the big endian to encode.

The flag ignored if the OFH_POLICY_OVERRIDE_SCHEMA_FRAMING_HEADER is used. Also, it can not be used with OFH_POLICY_USE_SCHEMA_ENDIANESS or OFH_POLICY_USE_LITTLE_ENDIAN flags .

See Also:

Constant Field Values

OFH_POLICY_OVERRIDE_SCHEMA_FRAMING_HEADER

public static final int OFH_POLICY_OVERRIDE_SCHEMA_FRAMING_HEADER

Override schema framing header specification.

When the flag is set the custom framing header specification completely overrides definition of the framing header appeared in the template.

Using of the flag cancels OFH_POLICY_USE_SCHEMA_ENDIANESS, OFH_POLICY_USE_BIG_ENDIAN and OFH_POLICY_USE_LITTLE_ENDIAN flags

See Also:

Constant Field Values

UseSchemaByStandard

public static final FramingHeaderPolicy UseSchemaByStandard

Default policy.

Use framing header specification from the template, or generate it by SBE 1.0 standard, and apply big endian encoding for it.

UseSchemaEndianess

public static final FramingHeaderPolicy UseSchemaEndianess

Override standard endianess with the schema-specified one.

Use framing header specification from the template and apply the schema endianess to it.

UseLittleEndian

public static final FramingHeaderPolicy UseLittleEndian

Override standard endianess with little endian.

Use framing header specification from the template and apply little-endian encoding to it.

UseBigEndian

public static final FramingHeaderPolicy UseBigEndian

Override standard endianess with big endian.

Use framing header specification from the template and apply big-endian encoding to it.

Constructor Detail

FramingHeaderPolicy

public FramingHeaderPolicy(FramingHeaderSpecification specification,
                           int flags)

Constructs new instance of the policy.

Parameters:

specification - framing header specification.

flags - combination of OFH_POLICY_* constants.

FramingHeaderPolicy

public FramingHeaderPolicy(FramingHeaderPolicy src)

Makes a copy of the policy.

The constructor copies data from the src object. The specification is not cloned and is shared between original object and the new one.

Parameters:

src - object to copy data from.

Method Detail

getSpecification

public FramingHeaderSpecification getSpecification()

Custom specification.

Returns:

framing header specification used by the policy.

getFlags

public int getFlags()

The policy flags.

Returns:

The set of OFH_POLICY_* flags.

getCustomPolicy

public static FramingHeaderPolicy getCustomPolicy(FramingHeaderSpecification specification)

Override standard or schema-specified framing header with the custom one.

Makes a policy instance that requires to use the custom framing header specification instead of the specification restored from the SBE template or created by standard considerations.

If the specification parameter can be null. In this case the encoder and decoder will not decode or encode the framing header.

Parameters:

specification - custom framing heade specification.

Returns:

new instance of the framing header policy.