biz.onixs.fix.parser

Class FlatMessage

java.lang.Object

biz.onixs.fix.parser.FlatMessage

All Implemented Interfaces:

Iterable<Field>

public class FlatMessage
extends Object
implements Iterable<Field>

FIX Protocol Message as a sequence of 'tag=value' pairs.

Constructor Summary

Constructors

Constructor and Description
FlatMessage() Constructor, empty message will be initialized and ready for interaction.
FlatMessage(byte[] rawFixMessage, int length) Constructor, given raw FIX message will be parsed and ready for interaction.
FlatMessage(FlatMessage flatMessage) Copy constructor.

Method Summary

Modifier and Type	Method and Description
FlatMessage	add(int tag, BigDecimal value) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, byte[] value) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, byte[] value, int offset, int length) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, ByteBuffer value) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, char value) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, CharSequence value) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, double value, int precision) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, HighResolutionTimestamp value, TimestampFormat format) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, int value) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int index, int tag, byte[] value) Adds given tag/value pair at the specified index of flat message.
FlatMessage	add(int index, int tag, byte[] value, int offset, int length) Adds given tag/value pair at the specified index of flat message.
FlatMessage	add(int index, int tag, CharSequence value) Adds given tag/value pair at the specified index of flat message.
FlatMessage	add(int index, int tag, ValuePtr value) Adds given tag/value pair at the specified index of flat message.
FlatMessage	add(int tag, LocalDateTime value) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, long value) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, ScaledDecimal value) Adds given tag/value pair at the end of flat message.
FlatMessage	add(int tag, ValuePtr value) Adds given tag/value pair at the end of flat message.
FlatMessage	addFlag(int tag, boolean value) Adds given tag/value("Y" or "N") pair at the end of flat message.
FlatMessage	addFlag(int index, int tag, boolean value) Adds given tag/value("Y" or "N") pair at the specified index of flat message.
FlatMessage	addTimestamp(int tag, long timeMillis) Adds given tag/value pair at the end of flat message.
boolean	append(int tag, StringBuilder builder) Appends field value to the specified StringBuilder.
void	assemble(ByteBuffer rawMsg) Assembles the FIX message to the given buffer.
boolean	checkType(char expectedType) Checks whether the message have the specified MsgType(35).
boolean	checkType(CharSequence expectedType) Checks whether the message have the specified MsgType(35).
boolean	contains(int tag) Returns whether the field corresponding to the given tag exists.
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.
int	findIndex(int tag) Find field index corresponding to the given tag.
int	findIndex(int tag, int hintPosition) Find field index corresponding to the given tag.
String	get(int tag) Returns the field value by the given tag.
boolean	get(int tag, Field field) Fills the given Field with reference to value by the given tag.
boolean	get(int tag, Field field, int hintPosition) Fills the given Field with reference to value by the given tag.
boolean	get(int tag, HighResolutionTimestamp value, TimestampFormat format) Fills the given HighResolutionTimestamp with value by the given tag.
boolean	get(int tag, HighResolutionTimestamp value, TimestampFormat format, int hintPosition) Fills the given HighResolutionTimestamp with value by the given tag.
String	get(int tag, int hintPosition) Returns the field value by the given tag.
boolean	get(int tag, ScaledDecimal value) Fills the given ScaledDecimal with value by the given tag.
boolean	get(int tag, ScaledDecimal value, int hintPosition) Fills the given ScaledDecimal with value by the given tag.
boolean	get(int tag, ValuePtr valuePtr) Fills the given ValuePtr with reference to value by the given tag.
boolean	get(int tag, ValuePtr valuePtr, int hintPosition) Fills the given ValuePtr with reference to value by the given tag.
BigDecimal	getBigDecimal(int tag) Returns the field value by the given tag.
BigDecimal	getBigDecimal(int tag, int hintPosition) Returns the field value by the given tag.
String	getByIndex(int index) Returns the field value at the given field index.
boolean	getByIndex(int index, Field field) Fills the field with tag/value from the given field index.
boolean	getByIndex(int index, HighResolutionTimestamp value, TimestampFormat format) Fills the given HighResolutionTimestamp with value by the given tag.
boolean	getByIndex(int index, ScaledDecimal value) Fills the given ScaledDecimal with value by the given tag.
boolean	getByIndex(int index, ValuePtr valuePtr) Fills the given ValuePtr with reference to value from the given field index.
BigDecimal	getByIndexBigDecimal(int index) Returns the field value at the given field index.
char	getByIndexChar(int index) Returns the field value at the given field index.
double	getByIndexDouble(int index) Returns the field value at the given field index.
HighResolutionTimestamp	getByIndexHighResolutionTimestamp(int index, TimestampFormat format) Returns the field value at the given field index.
int	getByIndexInteger(int index) Returns the field value at the given field index.
long	getByIndexLong(int index) Returns the field value at the given field index.
ScaledDecimal	getByIndexScaledDecimal(int index) Returns the field value at the given field index.
LocalDateTime	getByIndexUTCTimestamp(int index) Returns the field value at the given field index.
char	getChar(int tag) Returns the field value by the given tag.
char	getChar(int tag, int hintPosition) Returns the field value by the given tag.
double	getDouble(int tag) Returns the field value by the given tag.
double	getDouble(int tag, int hintPosition) Returns the field value by the given tag.
HighResolutionTimestamp	getHighResolutionTimestamp(int tag, TimestampFormat format) Returns the field value by the given tag.
HighResolutionTimestamp	getHighResolutionTimestamp(int tag, TimestampFormat format, int hintPosition) Returns the field value by the given tag.
int	getInteger(int tag) Returns the field value by the given tag.
int	getInteger(int tag, int hintPosition) Returns the field value by the given tag.
long	getLong(int tag) Returns the field value by the given tag.
long	getLong(int tag, int hintPosition) Returns the field value by the given tag.
int	getNumberOfFields() Return number of tag/value pairs.
ScaledDecimal	getScaledDecimal(int tag) Returns the field value by the given tag.
ScaledDecimal	getScaledDecimal(int tag, int hintPosition) Returns the field value by the given tag.
int	getTagByIndex(int index) Returns the field tag at the given field index.
LocalDateTime	getUTCTimestamp(int tag) Returns the field value by the given tag.
LocalDateTime	getUTCTimestamp(int tag, int hintPosition) Returns the field value by the given tag.
ArrayList<String>	getValues(int tag) Returns all the values for all occurrences of a particular tag.
void	getValues(int tag, List<String> list) Adds all the values for all occurrences of a particular tag to the given list.
boolean	hasFlag(int tag) Returns the flag value by the given tag.
Iterator<Field>	iterator()
FlatMessage	remove() Removes the last field.
boolean	remove(int tag) Removes the field corresponding to the given tag.
void	removeByIndex(int index) Removes the field at the given field index.
void	reset() Resets the flat message.
void	reset(byte[] rawFixMessage, int length) Resets the flat message with the given raw FIX message, allows to re-use internal data structures.
void	reset(FlatMessage flatMessage) Resets the flat message with the given one, allows to re-use internal data structures.
FlatMessage	set(int tag, BigDecimal value) Sets new value for the given tag.
FlatMessage	set(int tag, byte[] value) Sets new value for the given tag.
FlatMessage	set(int tag, byte[] value, int offset, int length) Sets new value for the given tag.
FlatMessage	set(int tag, ByteBuffer value) Sets new value at the given field index.
FlatMessage	set(int tag, char value) Sets new value for the given tag.
FlatMessage	set(int tag, CharSequence value) Sets new value for the given tag.
FlatMessage	set(int tag, double value, int precision) Sets new value for the given tag.
FlatMessage	set(int tag, HighResolutionTimestamp value, TimestampFormat format) Sets new value for the given tag.
FlatMessage	set(int tag, int value) Sets new value for the given tag.
FlatMessage	set(int tag, LocalDateTime value) Sets new value for the given tag.
FlatMessage	set(int tag, long value) Sets new value for the given tag.
FlatMessage	set(int tag, ScaledDecimal value) Sets new value for the given tag.
FlatMessage	set(int tag, ValuePtr value) Sets new value for the given tag.
FlatMessage	setByIndex(int index, BigDecimal value) Sets new value at the given field index.
FlatMessage	setByIndex(int index, byte[] value) Sets new value at the given field index.
FlatMessage	setByIndex(int index, byte[] value, int offset, int length) Sets new value at the given field index.
FlatMessage	setByIndex(int index, ByteBuffer value) Sets new value at the given field index.
FlatMessage	setByIndex(int index, char value) Sets new value at the given field index.
FlatMessage	setByIndex(int index, CharSequence value) Sets new value at the given field index.
FlatMessage	setByIndex(int index, double value, int precision) Sets new value at the given field index.
FlatMessage	setByIndex(int index, HighResolutionTimestamp value, TimestampFormat format) Sets new value at the given field index.
FlatMessage	setByIndex(int index, int value) Sets new value at the given field index.
FlatMessage	setByIndex(int index, LocalDateTime value) Sets new value at the given field index.
FlatMessage	setByIndex(int index, long value) Sets new value at the given field index.
FlatMessage	setByIndex(int index, ScaledDecimal value) Sets new value at the given field index.
FlatMessage	setByIndex(int index, ValuePtr value) Sets new value at the given field index.
FlatMessage	setFlag(int tag, boolean value) Sets new value for the given tag.
FlatMessage	setFlagByIndex(int index, boolean value) Sets new value at the given field index.
FlatMessage	setTimestamp(int tag, long timeMillis) Sets new value for the given tag as timestamp.
FlatMessage	setTimestampByIndex(int index, long timeMillis) Sets new value at the given field index as timestamp.
Stream<Field>	stream() Returns stream that contains all fields of the message.
String	toString()
void	toString(StringBuilder builder) Fills StringBuilder with the string representation of the object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FlatMessage

public FlatMessage()

Constructor, empty message will be initialized and ready for interaction.

FlatMessage

public FlatMessage(byte[] rawFixMessage,
                   int length)

Constructor, given raw FIX message will be parsed and ready for interaction.

Parameters:

rawFixMessage - raw FIX message in the tag=value form

length - the message length in bytes

FlatMessage

public FlatMessage(FlatMessage flatMessage)

Copy constructor.

Parameters:

flatMessage - source flat message to be copied

Method Detail

reset

public final void reset()

Resets the flat message.

reset

public final void reset(byte[] rawFixMessage,
                        int length)

Resets the flat message with the given raw FIX message, allows to re-use internal data structures.

Parameters:

rawFixMessage - raw FIX message in the tag=value form

length - the message length in bytes

reset

public final void reset(FlatMessage flatMessage)

Resets the flat message with the given one, allows to re-use internal data structures.

Parameters:

flatMessage - source flat message to be copied

assemble

public final void assemble(ByteBuffer rawMsg)

Assembles the FIX message to the given buffer.

Note: The fields order should comply with the FIX Protocol requirements: the first field should be BeginString, the second field should be BodyLength.

Note: If the last field is not CheckSum then it will be added.

Note: This method updates both BodyLength and CheckSum values.

Parameters:

rawMsg - target byte buffer

add

public final FlatMessage add(int tag,
                             char value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as char

Returns:

this

add

public final FlatMessage add(int tag,
                             int value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as int

Returns:

this

add

public final FlatMessage add(int tag,
                             long value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as long

Returns:

this

add

public final FlatMessage add(int tag,
                             double value,
                             int precision)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as double

precision - the number of digits in decimal part

Returns:

this

add

public final FlatMessage add(int tag,
                             BigDecimal value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as BigDecimal

Returns:

this

add

public final FlatMessage add(int tag,
                             ScaledDecimal value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as ScaledDecimal

Returns:

this

add

public final FlatMessage add(int tag,
                             LocalDateTime value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as LocalDateTime

Returns:

this

add

public final FlatMessage add(int tag,
                             HighResolutionTimestamp value,
                             TimestampFormat format)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as HighResolutionTimestamp

format - format to be used during parsing

Returns:

this

add

public final FlatMessage add(int tag,
                             CharSequence value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as CharSequence

Returns:

this

add

public final FlatMessage add(int tag,
                             ValuePtr value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as ValuePtr

Returns:

this

add

public final FlatMessage add(int tag,
                             byte[] value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as byte[]

Returns:

this

add

public final FlatMessage add(int tag,
                             byte[] value,
                             int offset,
                             int length)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as byte[]

offset - value offset

length - value length

Returns:

this

add

public final FlatMessage add(int tag,
                             ByteBuffer value)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as ByteBuffer

Returns:

this

addFlag

public FlatMessage addFlag(int tag,
                           boolean value)

Adds given tag/value("Y" or "N") pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

value - field value represented as boolean true for "Y", false for "N"

Returns:

this

addTimestamp

public FlatMessage addTimestamp(int tag,
                                long timeMillis)

Adds given tag/value pair at the end of flat message.

Note: Tag/value pair can be added multiple times, for example to build up a repeating group.

Parameters:

tag - field tag

timeMillis - time in milliseconds

Returns:

this

add

public final FlatMessage add(int index,
                             int tag,
                             CharSequence value)

Adds given tag/value pair at the specified index of flat message.

Parameters:

index - field to be added at the index

tag - field tag

value - field value represented as CharSequence

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

add

public final FlatMessage add(int index,
                             int tag,
                             ValuePtr value)

Adds given tag/value pair at the specified index of flat message.

Parameters:

index - field to be added at the index

tag - field tag

value - field value represented as ValuePtr

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

add

public final FlatMessage add(int index,
                             int tag,
                             byte[] value)

Adds given tag/value pair at the specified index of flat message.

Parameters:

index - field to be added at the index

tag - field tag

value - field value represented as byte[]

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

add

public final FlatMessage add(int index,
                             int tag,
                             byte[] value,
                             int offset,
                             int length)

Adds given tag/value pair at the specified index of flat message.

Parameters:

index - field to be added at the index

tag - field tag

value - field value represented as byte[]

offset - value offset

length - value length

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

addFlag

public final FlatMessage addFlag(int index,
                                 int tag,
                                 boolean value)

Adds given tag/value("Y" or "N") pair at the specified index of flat message.

Parameters:

index - field to be added at the index

tag - field tag

value - field value represented as boolean true for "Y", false for "N"

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

set

public final FlatMessage set(int tag,
                             char value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as char

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             int value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as int

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             long value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as long

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             double value,
                             int precision)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as double

precision - the number of digits in decimal part

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             BigDecimal value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as BigDecimal

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             ScaledDecimal value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as ScaledDecimal

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             LocalDateTime value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as LocalDateTime

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             HighResolutionTimestamp value,
                             TimestampFormat format)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as HighResolutionTimestamp

format - format to be used during parsing

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             CharSequence value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as CharSequence

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             ValuePtr value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as ValuePtr

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             byte[] value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as byte[]

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             byte[] value,
                             int offset,
                             int length)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as byte[]

offset - value offset

length - value length

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

set

public final FlatMessage set(int tag,
                             ByteBuffer value)

Sets new value at the given field index.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as ByteBuffer

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setFlag

public final FlatMessage setFlag(int tag,
                                 boolean value)

Sets new value for the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag

value - field value represented as boolean true for "Y", false for "N"

Returns:

this

Throws:

TagNotFoundException - in case the given tag does not exist in the flat message.

setTimestamp

public final FlatMessage setTimestamp(int tag,
                                      long timeMillis)

Sets new value for the given tag as timestamp.

Note: If there are multiple tag/value pairs corresponding to the given tag it will update the first one only.

Parameters:

tag - field tag number

timeMillis - time in milliseconds

Returns:

this

setByIndex

public final FlatMessage setByIndex(int index,
                                    char value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as char

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    int value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as int

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    long value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as long

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    double value,
                                    int precision)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as double

precision - the number of digits in decimal part

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    BigDecimal value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as BigDecimal

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    ScaledDecimal value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as ScaledDecimal

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    LocalDateTime value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as LocalDateTime

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    HighResolutionTimestamp value,
                                    TimestampFormat format)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as HighResolutionTimestamp

format - format to be used during parsing

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    CharSequence value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as CharSequence

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    ValuePtr value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as ValuePtr

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    byte[] value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as byte[]

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    byte[] value,
                                    int offset,
                                    int length)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as byte[]

offset - value offset

length - value length

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setByIndex

public final FlatMessage setByIndex(int index,
                                    ByteBuffer value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as ByteBuffer

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setFlagByIndex

public final FlatMessage setFlagByIndex(int index,
                                        boolean value)

Sets new value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

value - field value represented as boolean true for "Y", false for "N"

Returns:

this

Throws:

IndexNotFoundException - if the index is invalid.

setTimestampByIndex

public final FlatMessage setTimestampByIndex(int index,
                                             long timeMillis)

Sets new value at the given field index as timestamp.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair to be updated

timeMillis - time in milliseconds

Returns:

this

getChar

public final char getChar(int tag)

Returns the field value by the given tag.

Parameters:

tag - field tag

Returns:

the field value by the given tag, Character.MAX_VALUE if it is not found.

Throws:

ValueIsIncorrectException - if the value is not a char

getInteger

public final int getInteger(int tag)

Returns the field value by the given tag.

Parameters:

tag - field tag

Returns:

the field value by the given tag, Integer.MAX_VALUE if it is not found.

Throws:

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

getLong

public final long getLong(int tag)

Returns the field value by the given tag.

Parameters:

tag - field tag

Returns:

the field value by the given tag, Long.MAX_VALUE if it is not found.

Throws:

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

getDouble

public final double getDouble(int tag)

Returns the field value by the given tag.

Parameters:

tag - field tag

Returns:

the field value by the given tag, Double.NaN if it is not found.

Throws:

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

getBigDecimal

public final BigDecimal getBigDecimal(int tag)

Returns the field value by the given tag.

Parameters:

tag - field tag

Returns:

the field value by the given tag, null if it is not found.

Throws:

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

getScaledDecimal

public final ScaledDecimal getScaledDecimal(int tag)

Returns the field value by the given tag.

Parameters:

tag - field tag

Returns:

the field value by the given tag, null if it is not found.

Throws:

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

getUTCTimestamp

public final LocalDateTime getUTCTimestamp(int tag)

Returns the field value by the given tag.

Parameters:

tag - field tag

Returns:

the field value by the given tag, null if it is not found.

Throws:

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

getHighResolutionTimestamp

public final HighResolutionTimestamp getHighResolutionTimestamp(int tag,
                                                                TimestampFormat format)

Returns the field value by the given tag.

Parameters:

tag - field tag

format - format to be used during parsing

Returns:

the field value by the given tag, null if it is not found.

Throws:

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

get

public final String get(int tag)

Returns the field value by the given tag.

Parameters:

tag - field tag

Returns:

the field value by the given tag, null if it is not found.

get

public final boolean get(int tag,
                         ScaledDecimal value)

Fills the given ScaledDecimal with value by the given tag.

Parameters:

tag - field tag

value - object to be filled

Returns:

true in case the field is found, false otherwise.

Throws:

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

get

public final boolean get(int tag,
                         HighResolutionTimestamp value,
                         TimestampFormat format)

Fills the given HighResolutionTimestamp with value by the given tag.

Parameters:

tag - field tag

value - object to be filled

format - format to be used during parsing

Returns:

true in case the field is found, false otherwise.

Throws:

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

get

public final boolean get(int tag,
                         Field field)

Fills the given Field with reference to value by the given tag.

Parameters:

tag - field tag

field - field to be filled

Returns:

true in case the field is found, false otherwise.

get

public final boolean get(int tag,
                         ValuePtr valuePtr)

Fills the given ValuePtr with reference to value by the given tag.

Parameters:

tag - field tag

valuePtr - field value reference to be filled

Returns:

true in case the field is found, false otherwise.

getChar

public final char getChar(int tag,
                          int hintPosition)

Returns the field value by the given tag.

Parameters:

tag - field tag

hintPosition - The search will be started from this position

Returns:

the field value by the given tag, Character.MAX_VALUE if it is not found.

Throws:

ValueIsIncorrectException - if the value is not a char

getInteger

public final int getInteger(int tag,
                            int hintPosition)

Returns the field value by the given tag.

Parameters:

tag - field tag

hintPosition - The search will be started from this position

Returns:

the field value by the given tag, Integer.MAX_VALUE if it is not found.

Throws:

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

getLong

public final long getLong(int tag,
                          int hintPosition)

Returns the field value by the given tag.

Parameters:

tag - field tag

hintPosition - The search will be started from this position

Returns:

the field value by the given tag, Long.MAX_VALUE if it is not found.

Throws:

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

getDouble

public final double getDouble(int tag,
                              int hintPosition)

Returns the field value by the given tag.

Parameters:

tag - field tag

hintPosition - The search will be started from this position

Returns:

the field value by the given tag, Double.NaN if it is not found.

Throws:

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

getBigDecimal

public final BigDecimal getBigDecimal(int tag,
                                      int hintPosition)

Returns the field value by the given tag.

Parameters:

tag - field tag

hintPosition - The search will be started from this position

Returns:

the field value by the given tag, null if it is not found.

Throws:

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

getScaledDecimal

public final ScaledDecimal getScaledDecimal(int tag,
                                            int hintPosition)

Returns the field value by the given tag.

Parameters:

tag - field tag

hintPosition - The search will be started from this position

Returns:

the field value by the given tag, null if it is not found.

Throws:

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

getUTCTimestamp

public final LocalDateTime getUTCTimestamp(int tag,
                                           int hintPosition)

Returns the field value by the given tag.

Parameters:

tag - field tag

hintPosition - The search will be started from this position

Returns:

the field value by the given tag, null if it is not found.

Throws:

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

getHighResolutionTimestamp

public final HighResolutionTimestamp getHighResolutionTimestamp(int tag,
                                                                TimestampFormat format,
                                                                int hintPosition)

Returns the field value by the given tag.

Parameters:

tag - field tag

format - format to be used during parsing

hintPosition - The search will be started from this position

Returns:

the field value by the given tag, null if it is not found.

Throws:

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

get

public final String get(int tag,
                        int hintPosition)

Returns the field value by the given tag.

Parameters:

tag - field tag

hintPosition - The search will be started from this position

Returns:

the field value by the given tag, null if it is not found

get

public final boolean get(int tag,
                         ScaledDecimal value,
                         int hintPosition)

Fills the given ScaledDecimal with value by the given tag.

Parameters:

tag - field tag

value - object to be filled

hintPosition - The search will be started from this position

Returns:

true in case the field is found, false otherwise.

Throws:

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

get

public final boolean get(int tag,
                         HighResolutionTimestamp value,
                         TimestampFormat format,
                         int hintPosition)

Fills the given HighResolutionTimestamp with value by the given tag.

Parameters:

tag - field tag

value - object to be filled

format - format to be used during parsing

hintPosition - The search will be started from this position

Returns:

true in case the field is found, false otherwise.

Throws:

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

get

public final boolean get(int tag,
                         Field field,
                         int hintPosition)

Fills the given Field with reference to value by the given tag.

Parameters:

tag - field tag

field - field to be filled

hintPosition - The search will be started from this position

Returns:

true in case the field is found, false otherwise.

get

public final boolean get(int tag,
                         ValuePtr valuePtr,
                         int hintPosition)

Fills the given ValuePtr with reference to value by the given tag.

Parameters:

tag - field tag

valuePtr - field value reference to be filled

hintPosition - The search will be started from this position

Returns:

true in case the field is found, false otherwise.

getByIndexChar

public final char getByIndexChar(int index)

Returns the field value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

Returns:

the field value.

Throws:

IndexNotFoundException - if the index is invalid.

ValueIsIncorrectException - if the value is not a char

getByIndexInteger

public final int getByIndexInteger(int index)

Returns the field value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

Returns:

the field value.

Throws:

IndexNotFoundException - if the index is invalid.

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

getByIndexLong

public final long getByIndexLong(int index)

Returns the field value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

Returns:

the field value.

Throws:

IndexNotFoundException - if the index is invalid.

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

getByIndexDouble

public final double getByIndexDouble(int index)

Returns the field value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

Returns:

the field value.

Throws:

IndexNotFoundException - if the index is invalid.

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

getByIndexBigDecimal

public final BigDecimal getByIndexBigDecimal(int index)

Returns the field value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

Returns:

the field value.

Throws:

IndexNotFoundException - if the index is invalid.

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

getByIndexScaledDecimal

public final ScaledDecimal getByIndexScaledDecimal(int index)

Returns the field value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

Returns:

the field value.

Throws:

IndexNotFoundException - if the index is invalid.

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

getByIndexUTCTimestamp

public final LocalDateTime getByIndexUTCTimestamp(int index)

Returns the field value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

Returns:

the field value.

Throws:

IndexNotFoundException - if the index is invalid.

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

getByIndexHighResolutionTimestamp

public final HighResolutionTimestamp getByIndexHighResolutionTimestamp(int index,
                                                                       TimestampFormat format)

Returns the field value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

format - format to be used during parsing

Returns:

the field value.

Throws:

IndexNotFoundException - if the index is invalid.

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

getByIndex

public final String getByIndex(int index)

Returns the field value at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

Returns:

the field value.

Throws:

IndexNotFoundException - if the index is invalid.

getByIndex

public final boolean getByIndex(int index,
                                ScaledDecimal value)

Fills the given ScaledDecimal with value by the given tag.

Parameters:

index - index of tag/value pair

value - object to be filled

Returns:

true in case the field is found, false otherwise.

Throws:

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

getByIndex

public final boolean getByIndex(int index,
                                HighResolutionTimestamp value,
                                TimestampFormat format)

Fills the given HighResolutionTimestamp with value by the given tag.

Parameters:

index - index of tag/value pair

value - object to be filled

format - format to be used during parsing

Returns:

true in case the field is found, false otherwise.

Throws:

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

getByIndex

public final boolean getByIndex(int index,
                                Field field)

Fills the field with tag/value from the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

field - field to be filled

Returns:

true in case the field index is valid, false otherwise.

getByIndex

public final boolean getByIndex(int index,
                                ValuePtr valuePtr)

Fills the given ValuePtr with reference to value from the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

valuePtr - field value reference to be filled

Returns:

true in case the field index is valid, false otherwise.

getTagByIndex

public final int getTagByIndex(int index)

Returns the field tag at the given field index.

Note: Field index can be found using findIndex(int) method.

Parameters:

index - index of tag/value pair

Returns:

the field tag.

Throws:

IndexNotFoundException - if the index is invalid.

getValues

public final ArrayList<String> getValues(int tag)

Returns all the values for all occurrences of a particular tag.

Parameters:

tag - fields tag

Returns:

all the values for all occurences of a particular tag.

getValues

public final void getValues(int tag,
                            List<String> list)

Adds all the values for all occurrences of a particular tag to the given list.

Parameters:

tag - field tag

list - list to be filled

hasFlag

public boolean hasFlag(int tag)

Returns the flag value by the given tag.

Parameters:

tag - field tag

Returns:

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

contains

public boolean contains(int tag)

Returns whether the field corresponding to the given tag exists.

Parameters:

tag - field tag

Returns:

true in case exits, false otherwise.

containsSame

public boolean containsSame(int tag,
                            CharSequence expectedValue)

Returns whether the field corresponding to the given tag exists and have the same value.

Parameters:

tag - field tag number

expectedValue - expected value

Returns:

true in case exits, false otherwise

containsSame

public 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.

Parameters:

tag - field tag number

expectedValue - expected value

offset - expected value offset

length - expected value length

Returns:

true in case exits, false otherwise

append

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

findIndex

public final int findIndex(int tag)

Find field index corresponding to the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will return the first one only.

Parameters:

tag - field tag

Returns:

field index corresponding to the given tag.

findIndex

public final int findIndex(int tag,
                           int hintPosition)

Find field index corresponding to the given tag.

Note: If there are multiple tag/value pairs corresponding to the given tag it will return the first one only.

Parameters:

tag - field tag

hintPosition - The search will be started from this position.

Returns:

field index corresponding to the given tag.

getNumberOfFields

public final int getNumberOfFields()

Return number of tag/value pairs.

Returns:

number of tag/value pairs.

checkType

public boolean checkType(char expectedType)

Checks whether the message have the specified MsgType(35).

Parameters:

expectedType - expected message type

Returns:

whether the message have the specified MsgType(35)

checkType

public boolean checkType(CharSequence expectedType)

Checks whether the message have the specified MsgType(35).

Parameters:

expectedType - expected message type

Returns:

whether the message have the specified MsgType(35)

remove

public final FlatMessage remove()

Removes the last field.

Returns:

this

remove

public boolean remove(int tag)

Removes the field corresponding to the given tag.

Note: After removing tag the found indexes will not be valid.

Parameters:

tag - field tag

Returns:

true in case the field is found, false otherwise.

removeByIndex

public void removeByIndex(int index)

Removes the field at the given field index.

Note: After removing a field the found indexes will not be valid.

Parameters:

index - index of tag/value pair to be removed

Throws:

IndexNotFoundException - if the index is invalid.

toString

public final void toString(StringBuilder builder)

Fills StringBuilder with the string representation of the object.

Parameters:

builder - string builder to be filled

stream

public Stream<Field> stream()

Returns stream that contains all fields of the message.

Returns:

Stream with fields.

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<Field> iterator()

Specified by:

iterator in interface Iterable<Field>