FlatGroupReader (Java FIX Engine Package 2.13.5 API)

java.lang.Object
- biz.onixs.fix.parser.FlatGroupReader

All Implemented Interfaces:

Iterator<FlatGroupReader>
```
public class FlatGroupReader
extends Object
implements Iterator<FlatGroupReader>
```
Reader for repeating group in the flat message.

Constructor Summary

Constructors
Constructor and Description
`FlatGroupReader(FlatGroupReader other)` Copy constructor.
`FlatGroupReader(GroupDefinition definition)` Constructs reader on the base of the group definition.
`FlatGroupReader(Object... items)` Constructor with in-place dictionary.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(int tag)` Returns whether the field with the specified tag number is set.
`String`	`get(int tag)` Returns the field value by the given tag.
`BigDecimal`	`getBigDecimal(int tag)` Returns the field value by the given tag.
`char`	`getChar(int tag)` Returns the field value by the given tag.
`int`	`getCurrentEntry()` Index of the current group entry.
`double`	`getDouble(int tag)` Returns the field value by the given tag.
`HighResolutionTimestamp`	`getHighResolutionTimestamp(int tag, TimestampFormat format)` Returns the field value by the given tag.
`int`	`getInteger(int tag)` Returns the field value as integer.
`long`	`getLong(int tag)` Returns the field value by the given tag.
`FlatMessage`	`getMessage()` The wrapped message.
`int`	`getNumberOfInstances()` Returns number of entries in the repeating group.
`FlatGroupReader`	`getParent()` Gets parent accessor.
`ScaledDecimal`	`getScaledDecimal(int tag)` Returns the field value by the given tag.
`LocalDateTime`	`getUTCTimestamp(int tag)` Returns field value as `LocalDateTime`.
`boolean`	`hasNext()` Check whether the next entry available.
`FlatGroupReader`	`next()` Moves the accessor to the next entry.
`void`	`reset()` Resets the accessor to the state "before zeroth element" of the group.
`void`	`unwrap()` Detaches the reader from message or another reader.
`boolean`	`wrap(FlatGroupReader parentReader)` Attaches the accessor as nested group.
`boolean`	`wrap(FlatMessage message)` Attaches reader to the message as top-level group.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining, remove

- Constructor Detail
  - FlatGroupReader
```
public FlatGroupReader(Object... items)
```
    Constructor with in-place dictionary.
    The constructor allows to create dictionary together with the accessor.
    
    The dictionary will be built of the tags and subgroup dictionaries provided as arguments.
    
    Parameters:
    
    items - Tags and subgroup dictionaries to be included into the reader's dictionary.
  - FlatGroupReader
```
public FlatGroupReader(GroupDefinition definition)
```
    Constructs reader on the base of the group definition.
    
    Parameters:
    
    definition - Group definition obtained from the FIX dictionary.
  - FlatGroupReader
```
public FlatGroupReader(FlatGroupReader other)
```
    Copy constructor.
    Duplicates state of the reader that is passed as the argument.
    
    The dictionary used by the other reader is shared with the reader being constructed (even if the dictionary was generated specifically for the reader).
    
    Parameters:
    
    other - Reader to copy state from.
- Method Detail
  - getParent
```
public FlatGroupReader getParent()
```
    Gets parent accessor.
    
    Returns:
    
    Parent accessor if ones present.
  - reset
```
public void reset()
```
    Resets the accessor to the state "before zeroth element" of the group.
  - hasNext
```
public boolean hasNext()
```
    Check whether the next entry available.
    
    Specified by:
    
    hasNext in interface Iterator<FlatGroupReader>
    
    Returns:
    
    True if the next entry available, false otherwise.
  - next
```
public FlatGroupReader next()
```
    Moves the accessor to the next entry.
    
    Specified by:
    
    next in interface Iterator<FlatGroupReader>
    
    Returns:
    
    The accessor itself if the movement succeded.
    
    Throws:
    
    NoSuchElementException - when the sequence is ended.
  - getCurrentEntry
```
public int getCurrentEntry()
```
    Index of the current group entry.
    
    Returns:
    
    Index of the entry.
  - getNumberOfInstances
```
public int getNumberOfInstances()
```
    Returns number of entries in the repeating group.
    
    Returns:
    
    Number of entries.
  - getMessage
```
public FlatMessage getMessage()
```
    The wrapped message.
    
    Returns:
    
    The message used in the wrap(FlatMessage) method.
  - wrap
```
public boolean wrap(FlatMessage message)
```
    Attaches reader to the message as top-level group.
    This method attaches the accessor to the given message as an accessor to the top-level group.
    
    Parameters:
    
    message - Message to use.
    
    Returns:
    
    true if the message contains the group, false otherwise.
  - wrap
```
public boolean wrap(FlatGroupReader parentReader)
```
    Attaches the accessor as nested group.
    Attaches the accessor to another accessor to provide access to the nested group.
    
    Please note that modifying state of the parent accessor invalidates state of the nested accessor.
    
    Parameters:
    
    parentReader - Parent group.
    
    Returns:
    
    true if the parentReader current entry contains the group, false otherwise.
  - unwrap
```
public void unwrap()
```
    Detaches the reader from message or another reader.
    This method detaches the reader from the message or another reader that was previously attached using wrap(FlatMessage) or wrap(FlatGroupReader) methods.
  - contains
```
public 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
  - getInteger
```
public 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
  - getLong
```
public 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
  - getChar
```
public 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
  - getDouble
```
public 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
  - getScaledDecimal
```
public 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
  - getBigDecimal
```
public 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
  - get
```
public 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.
  - getHighResolutionTimestamp
```
public 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
  - getUTCTimestamp
```
public 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

Class FlatGroupReader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Constructor Detail

FlatGroupReader

FlatGroupReader

FlatGroupReader

Method Detail

getParent

reset

hasNext

next

getCurrentEntry

getNumberOfInstances

getMessage

wrap

wrap

unwrap

contains

getInteger

getLong

getChar

getDouble

getScaledDecimal

getBigDecimal

get

getHighResolutionTimestamp

getUTCTimestamp