biz.onixs.fix.parser

Interface FixBlock

All Superinterfaces:

Iterable<Field>

All Known Implementing Classes:

FixBlockExtendedX.FixBlockExtended, FixBlockExtendedX.MessageExtended, GroupInstance, Message

public interface FixBlock
extends Iterable<Field>

Method Summary

Modifier and Type	Method and Description
boolean	append(int tag, StringBuilder builder) Appends field value to the specified StringBuilder.
FixBlock	assemble(ByteBuffer buffer) Assembles the FIX message to the target byte buffer.
FixBlock	assemble(FlatMessage flatMessage) Assembles the FIX message to the target FlatMessage.
boolean	contains(int tag) Returns whether the field with the specified tag number is set.
boolean	contains(int tag, boolean nested) Returns whether the field with the specified tag number is set.
boolean	containsSame(int tag, byte[] expectedValue, int offset, int length) Returns whether the field corresponding to the given tag exists and have the same value.
boolean	containsSame(int tag, CharSequence expectedValue) Returns whether the field corresponding to the given tag exists and have the same value.
String	get(int tag) Returns the field value as string.
boolean	get(int tag, ValuePtr value) Returns field value as ValuePtr using provided value object instance.
BigDecimal	getBigDecimal(int tag) Returns the field value as BigDecimal.
byte[]	getBytes(int tag) Returns the field value as a byte array.
char	getChar(int tag) Returns the field value as character.
double	getDouble(int tag) Returns the field value as double.
Group	getGroup(int tag) Returns the repeating group.
boolean	getHighResolutionTimestamp(int tag, HighResolutionTimestamp value, TimestampFormat format) Returns field value as HighResolutionTimestamp using provided value object instance and parsed using specified TimestampFormat format.
HighResolutionTimestamp	getHighResolutionTimestamp(int tag, TimestampFormat format) Returns field value as HighResolutionTimestamp parsed using specified TimestampFormat format.
int	getInteger(int tag) Returns the field value as integer.
long	getLong(int tag) Returns the field value as long.
int	getNumberOfGroups() Returns number of repeating groups defined on the current level excluding nested repeating groups.
ScaledDecimal	getScaledDecimal(int tag) Returns field value as ScaledDecimal.
boolean	getScaledDecimal(int tag, ScaledDecimal value) Returns field value as ScaledDecimal using provided value object instance.
int	getSize() Returns the number of tag/value pairs excluding nested repeating groups.
LocalDateTime	getUTCTimestamp(int tag) Returns field value as LocalDateTime.
ValuePtr	getValuePtr(int tag) Returns field value as ValuePtr.
boolean	hasFlag(int tag) Returns the flag value.
boolean	hasGroup(int tag) Returns whether repeating group belongs to the fix block and actually exists.
Iterator<Group>	iteratorOverGroups() Returns an iterator over groups of the current level excludes nested repeating groups.
boolean	remove(int tag) Removes the field with the specified tag number.
FixBlock	set(int tag, BigDecimal value) Sets the field value as BigDecimal using provided value object instance.
FixBlock	set(int tag, byte[] buffer) Sets the field value.
FixBlock	set(int tag, byte[] buffer, int valueLength) Sets the field value.
FixBlock	set(int tag, byte[] buffer, int valueOffset, int valueLength) Sets the field value.
FixBlock	set(int tag, ByteBuffer buffer) Sets ByteBuffer field value.
FixBlock	set(int tag, char value) Sets the field value as character.
FixBlock	set(int tag, CharSequence value) Sets the field value as string.
FixBlock	set(int tag, double value) Sets the double field value.
FixBlock	set(int tag, double value, int precision) Sets the field value as double.
FixBlock	set(int tag, HighResolutionTimestamp value, TimestampFormat format) Sets the field value as HighResolutionTimestamp formatting it using specified TimestampFormat format.
FixBlock	set(int tag, int value) Sets the field value as integer.
FixBlock	set(int tag, LocalDateTime value) Sets the field value as LocalDateTime formatting it to timestamp.
FixBlock	set(int tag, long value) Sets the long field value.
FixBlock	set(int tag, ScaledDecimal value) Sets ScaledDecimal field value.
FixBlock	set(int tag, ValuePtr value) Sets ValuePtr field value.
FixBlock	setFlag(int tag, boolean value) Sets the flag tag value - "Y" or "N".
FixBlock	setGroup(Group srcGroup) Copies an entire repeating group from one fix block to another.
Group	setGroup(int tag, int numberOfInstances) Creates a new repeating group or changes the number of instances in the existing repeating group.
FixBlock	setTimestamp(int tag, long timeMillis) Sets the field value as timestamp.
Stream<Field>	stream() Returns stream that contains all fields of the current level without groups.
Stream<Group>	streamOverGroups() Returns stream thta contains groups of the current level.
String	toFixString() Returns string representation of the message.
String	toJson() Returns string representation of the message in JSON format.
String	toString(char delimiter) Returns string representation of the message using specified delimiter.
String	toString(char delimiter, Message.StringFormat format) Returns string representation of the message using specified delimiter and format.
String	toString(Message.StringFormat format) Returns string representation of the message using specified format.
String	toXml() Returns string representation of the message in pretty XML format.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

assemble

FixBlock assemble(FlatMessage flatMessage)

Assembles the FIX message to the target FlatMessage.

Parameters:

flatMessage - target FlatMessage

Returns:

reference to this object.

Throws:

NullPointerException - if flatMessage == null

assemble

FixBlock assemble(ByteBuffer buffer)

Assembles the FIX message to the target byte buffer.
Please make sure the buffer is clear, the method does not clear it.

Parameters:

buffer - target byte buffer

Returns:

reference to this object.

Throws:

NullPointerException - if buffer == null

remove

boolean remove(int tag)

Removes the field with the specified tag number.

Parameters:

tag - field tag number

Returns:

true if the field was found and removed, otherwise false

contains

boolean contains(int tag)

Returns whether the field with the specified tag number is set.
Please note that the checking excludes nested repeating groups.

Parameters:

tag - field tag number

Returns:

true if the field is set,false if the field is not set or is not defined for this message

contains

boolean contains(int tag,
                 boolean nested)

Returns whether the field with the specified tag number is set.

Parameters:

tag - field tag number

nested - true for checking nested repeating groups recursively, false for flat checking

Returns:

true if the field is set,false if the field is not set or is not defined for this message

containsSame

boolean containsSame(int tag,
                     CharSequence expectedValue)

Returns whether the field corresponding to the given tag exists and have the same value.
Please note that the checking excludes nested repeating groups.

Parameters:

tag - field tag number

expectedValue - expected value

Returns:

true in case exits, false otherwise

containsSame

boolean containsSame(int tag,
                     byte[] expectedValue,
                     int offset,
                     int length)

Returns whether the field corresponding to the given tag exists and have the same value.
Please note that the checking excludes nested repeating groups.

Parameters:

tag - field tag number

expectedValue - expected value

offset - expected value offset

length - expected value length

Returns:

true in case exits, false otherwise

getChar

char getChar(int tag)

Returns the field value as character.
Whether the value is set or not can be checked using contains(int).

Parameters:

tag - field tag number

Returns:

field value as character, Character.MAX_VALUE if it is not set

Throws:

ValueIsIncorrectException - if the value can't be parsed to int

set

FixBlock set(int tag,
             char value)

Sets the field value as character.

Parameters:

tag - field tag number

value - field value

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

getInteger

int getInteger(int tag)

Returns the field value as integer.
Whether the value is set or not can be checked using contains(int).

Parameters:

tag - field tag number

Returns:

field value as integer, Integer.MAX_VALUE if it is not set

Throws:

ValueIsIncorrectException - if the value can't be parsed to int

set

FixBlock set(int tag,
             int value)

Sets the field value as integer.

Parameters:

tag - field tag number

value - field value

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

getLong

long getLong(int tag)

Returns the field value as long.
Whether the value is set or not can be checked using contains(int).

Parameters:

tag - field tag number

Returns:

field value as long, Long.MAX_VALUE if it is not set

Throws:

ValueIsIncorrectException - if the value can't be parsed to long

set

FixBlock set(int tag,
             long value)

Sets the long field value.

Parameters:

tag - field tag number

value - field value

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

getDouble

double getDouble(int tag)

Returns the field value as double.
Please note that according to the FIX float format the value should not contain exponent(e.g. 'e' or 'E' symbol).
Whether the value is set or not can be checked using contains(int).
Warning. The double type shouldn't be used for precise values.

Parameters:

tag - field tag number

Returns:

field value as double, Double.NaN if it is not set

Throws:

ValueIsIncorrectException - if the value can't be parsed to double

set

FixBlock set(int tag,
             double value)

Sets the double field value.
Warning. The double type shouldn't be used for precise values.
Please note that the number of digits in the decimal part will be equal to 6.
Please also note that the number will be rounded towards nearest neighbor unless both neighbors are equidistant, in which case round up.

Parameters:

tag - field tag number

value - field value

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

IllegalArgumentException - if (index < 0)

set

FixBlock set(int tag,
             double value,
             int precision)

Sets the field value as double.
Warning. The double type shouldn't be used for precise values.
Please also note that the number will be rounded towards nearest neighbor unless both neighbors are equidistant, in which case round up.

Parameters:

tag - field tag number

value - field value

precision - the number of digits in decimal part

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

IllegalArgumentException - if (index < 0)

getBigDecimal

BigDecimal getBigDecimal(int tag)

Returns the field value as BigDecimal.
Whether the value is set or not can be checked using contains(int).

Parameters:

tag - field tag number

Returns:

field value as BigDecimal, null if it is not set

Throws:

ValueIsIncorrectException - if the value can't be parsed to BigDecimal

set

FixBlock set(int tag,
             BigDecimal value)

Sets the field value as BigDecimal using provided value object instance.

Parameters:

tag - field tag number

value - field value

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

NullPointerException - if (value == null)

getScaledDecimal

ScaledDecimal getScaledDecimal(int tag)

Returns field value as ScaledDecimal.

Parameters:

tag - field tag number

Returns:

field value or null if it is not available

Throws:

ValueIsIncorrectException - if the field value can't be parsed to ScaledDecimal

getScaledDecimal

boolean getScaledDecimal(int tag,
                         ScaledDecimal value)

Returns field value as ScaledDecimal using provided value object instance.

Parameters:

tag - field tag number

value - field value

Returns:

whether value available

Throws:

NullPointerException - if (value == null)

ValueIsIncorrectException - if the field value can't be parsed to ScaledDecimal

set

FixBlock set(int tag,
             ScaledDecimal value)

Sets ScaledDecimal field value.

Parameters:

tag - field tag number

value - field value

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

NullPointerException - if (value == null)

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

setTimestamp

FixBlock setTimestamp(int tag,
                      long timeMillis)

Sets the field value as timestamp.

Parameters:

tag - field tag number

timeMillis - time in milliseconds

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

getUTCTimestamp

LocalDateTime getUTCTimestamp(int tag)

Returns field value as LocalDateTime.

Parameters:

tag - field tag number

Returns:

field value or null if it is not available

Throws:

ValueIsIncorrectException - if the field value can't be parsed to LocalDateTime

set

FixBlock set(int tag,
             LocalDateTime value)

Sets the field value as LocalDateTime formatting it to timestamp.

Parameters:

tag - field tag number

value - field value

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

NullPointerException - if (value == null)

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

getHighResolutionTimestamp

HighResolutionTimestamp getHighResolutionTimestamp(int tag,
                                                   TimestampFormat format)

Returns field value as HighResolutionTimestamp parsed using specified TimestampFormat format.

Parameters:

tag - field tag number

format - format to be used during parsing

Returns:

field value or null if it is not available

Throws:

ValueIsIncorrectException - if the field value can't be parsed to HighResolutionTimestamp with specified TimestampFormat format

getHighResolutionTimestamp

boolean getHighResolutionTimestamp(int tag,
                                   HighResolutionTimestamp value,
                                   TimestampFormat format)

Returns field value as HighResolutionTimestamp using provided value object instance and parsed using specified TimestampFormat format.

Parameters:

tag - field tag number

value - field value

format - format to be used during parsing

Returns:

whether value available

Throws:

NullPointerException - if ("value == null")

ValueIsIncorrectException - if the field value can't be parsed to HighResolutionTimestamp with specified TimestampFormat format

set

FixBlock set(int tag,
             HighResolutionTimestamp value,
             TimestampFormat format)

Sets the field value as HighResolutionTimestamp formatting it using specified TimestampFormat format.

Parameters:

tag - field tag number

value - field value

format - format to be used for formatting

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

NullPointerException - if (value == null)

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

get

String get(int tag)

Returns the field value as string.

Parameters:

tag - field tag number

Returns:

field value as string, null if it is not set

set

FixBlock set(int tag,
             CharSequence value)

Sets the field value as string.

Parameters:

tag - field tag number

value - field value

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

NullPointerException - if (value == null)

getValuePtr

ValuePtr getValuePtr(int tag)

Returns field value as ValuePtr.
Warning. Only read access to the returned array is allowed.

Parameters:

tag - field tag number

Returns:

value pointer, use ValuePtr.isSet() to check whether value is set

get

boolean get(int tag,
            ValuePtr value)

Returns field value as ValuePtr using provided value object instance.
This is the most efficient way to access a field value.
Warning. Only read access to the returned array is allowed.

Parameters:

tag - field tag number

value - pointer to pass value

Returns:

whether value available

set

FixBlock set(int tag,
             ValuePtr value)

Sets ValuePtr field value.

Parameters:

tag - field tag number

value - value pointer

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

NullPointerException - if (valuePtr == null)

IllegalArgumentException - if !valuePtr.isSet()

set

FixBlock set(int tag,
             ByteBuffer buffer)

Sets ByteBuffer field value.

Parameters:

tag - field tag number

buffer - field value

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

NullPointerException - if (buffer == null)

getBytes

byte[] getBytes(int tag)

Returns the field value as a byte array.

Parameters:

tag - field tag number

Returns:

field value as a byte array, null if it is not set

set

FixBlock set(int tag,
             byte[] buffer)

Sets the field value.

Parameters:

tag - field tag number

buffer - byte buffer

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

NullPointerException - if (buffer == null)

set

FixBlock set(int tag,
             byte[] buffer,
             int valueLength)

Sets the field value.

Parameters:

tag - field tag number

buffer - byte buffer

valueLength - value length in the buffer

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

NullPointerException - if (buffer == null)

IllegalArgumentException - (length > buffer.length or (valueLength < 0)

set

FixBlock set(int tag,
             byte[] buffer,
             int valueOffset,
             int valueLength)

Sets the field value.

Parameters:

tag - field tag number

buffer - byte buffer

valueOffset - value offset in the buffer

valueLength - value length in the buffer

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

NullPointerException - if (buffer == null)

IllegalArgumentException - (valueOffset < 0) or (valueOffset + valueLength > buffer.length) or (valueLength < 0)

append

boolean append(int tag,
               StringBuilder builder)

Appends field value to the specified StringBuilder.

Parameters:

tag - field tag number

builder - string builder value of the field to be appended

Returns:

true if the value was appended, and false otherwise

Throws:

NullPointerException - if (buffer == null)

hasFlag

boolean hasFlag(int tag)

Returns the flag value.

Parameters:

tag - field tag number

Returns:

whether field value is equal to "Y" or "y"

setFlag

FixBlock setFlag(int tag,
                 boolean value)

Sets the flag tag value - "Y" or "N".

Parameters:

tag - field tag number

value - true for "Y", false for "N"

Returns:

reference to this object. Please use contains(int) to check if the field had a value.

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

hasGroup

boolean hasGroup(int tag)

Returns whether repeating group belongs to the fix block and actually exists.
Please note that the checking excludes nested repeating groups.

Parameters:

tag - tag number of the field that defines the number of instances in this repeating group (the NoXXX field)

Returns:

true in case repeating group belongs to the fix block and actually exists, false otherwise

getGroup

Group getGroup(int tag)

Returns the repeating group.

Parameters:

tag - tag number of the field that defines the number of instances in this repeating group (the NoXXX field)

Returns:

nested repeating group

Throws:

ParserException - tag number does not belong to the message

setGroup

Group setGroup(int tag,
               int numberOfInstances)

Creates a new repeating group or changes the number of instances in the existing repeating group.

Parameters:

tag - tag number of the field that defines the number of instances in this repeating group (the NoXXX field)

numberOfInstances - number of instances in the repeating group

Returns:

repeating group

Throws:

TagNotDefinedForThisMessageTypeException - if field with the specified tag is not defined for this message and unknown fields are disabled

setGroup

FixBlock setGroup(Group srcGroup)

Copies an entire repeating group from one fix block to another.

Parameters:

srcGroup - source group to be copied

Returns:

reference to this object.

Throws:

NullPointerException - if (srcGroup == null)

getNumberOfGroups

int getNumberOfGroups()

Returns number of repeating groups defined on the current level excluding nested repeating groups.

Returns:

number of repeating groups defined on the current level excluding nested repeating groups

getSize

int getSize()

Returns the number of tag/value pairs excluding nested repeating groups.

Returns:

the number of tag/value pairs excluding nested repeating groups.

toJson

String toJson()

Returns string representation of the message in JSON format.

Returns:

FIX message as string in JSON format

toXml

String toXml()

Returns string representation of the message in pretty XML format.

Returns:

FIX message as string in pretty XML format

toFixString

String toFixString()

Returns string representation of the message.
This method will re-calculate the BodyLength and Checksum according to the message.

Returns:

string representation of the message

toString

String toString(char delimiter)

Returns string representation of the message using specified delimiter.
Default format is Message.StringFormat.TAG_NUMBER.

Parameters:

delimiter - delimiter to use

Returns:

FIX message as string

toString

String toString(Message.StringFormat format)

Returns string representation of the message using specified format.
Default delimiter is FixParserUtil.DELIM_CHAR.

Parameters:

format - format to use

Returns:

FIX message as string

Throws:

NullPointerException - if (null == format)

toString

String toString(char delimiter,
                Message.StringFormat format)

Returns string representation of the message using specified delimiter and format.

Parameters:

format - format to use

delimiter - delimiter to use

Returns:

FIX message as string

Throws:

NullPointerException - if (null == format)

iteratorOverGroups

Iterator<Group> iteratorOverGroups()

Returns an iterator over groups of the current level excludes nested repeating groups.

Returns:

an iterator over groups of the current level excludes nested repeating groups

stream

Stream<Field> stream()

Returns stream that contains all fields of the current level without groups.

Returns:

Stream with fields.

streamOverGroups

Stream<Group> streamOverGroups()

Returns stream thta contains groups of the current level.

Returns:

Stream with groups.