biz.onixs.sbe.def

Class FramingHeaderSpecification.FieldSpecification

java.lang.Object

biz.onixs.sbe.def.FramingHeaderSpecification.FieldSpecification

Direct Known Subclasses:

FramingHeaderSpecification.EndianessFieldSpecification

Enclosing class:

FramingHeaderSpecification

public static class FramingHeaderSpecification.FieldSpecification
extends Object

Field specification.

The main characteristics required for a field specification: offset, size, sign, and byte order.

Constructor Summary

Constructors

Constructor and Description
FieldSpecification(int offset, int size, boolean signed, MessageSchema.Endianess endianess) Constructor.

Method Summary

Modifier and Type	Method and Description
MessageSchema.Endianess	getEndianess() Byte order of the field.
int	getOffset() Offset of the field.
int	getSize() Size of the field.
UnifiedMetaData.PrimitiveType	getSuitablePrimitive() Primitive SBE type for the field.
boolean	isSigned() Checks if the field use signed type to encode.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldSpecification

public FieldSpecification(int offset,
                          int size,
                          boolean signed,
                          MessageSchema.Endianess endianess)

Constructor.

Parameters:

offset - Offset of the field.

size - Size of the field, in bytes.

signed - true if the field encoded with signed type.

endianess - Byte order for the field.

Method Detail

getOffset

public int getOffset()

Offset of the field.

Returns:

Ofsset of the field.

getSize

public int getSize()

Size of the field.

Returns:

Size of the field, in bytes.

isSigned

public boolean isSigned()

Checks if the field use signed type to encode.

Returns:

Result of the check.

getEndianess

public MessageSchema.Endianess getEndianess()

Byte order of the field.

Returns:

Byte order used for the field.

getSuitablePrimitive

public UnifiedMetaData.PrimitiveType getSuitablePrimitive()

Primitive SBE type for the field.

Returns:

Primitive type for the field.