IFieldSet (OnixS CME iLink3 Handler Parent 1.1.1 API)

All Known Subinterfaces:

IGroup, IMessage

All Known Implementing Classes:

Group, Message
```
public interface IFieldSet
```

Field Summary

Fields
Modifier and Type Field and Description

static char DefaultSeparator

Fields
Modifier and Type	Field and Description
`static char`	`DefaultSeparator`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`contains(int tag)` Returns true if field belongs to field set and has not null value.
`Object`	`createEmptyStandardComposite(int tag, Object ref)` Creates null object of the standard composite type.
`ScaledDecimal`	`createNullDecimal(int tag, ScaledDecimal ref)` Create null value for the given field.
`MonthYear`	`createNullMonthYear(int tag, MonthYear ref)` Creates null MonthYear object.
`SbeTimestamp`	`createNullTimestamp(int tag, SbeTimestamp ref)` Creates null MonthYear object.
`int[]`	`dataTags()` Returns ids of number of instances tags of variadic-length fields, belonging to this field set.
`int[]`	`fieldTags()` Returns ids of all fields
`boolean`	`getBoolean(int tag)` Gets field value by tag.
`byte`	`getByte(int tag)` Gets field value by tag.
`byte[]`	`getBytes(int tag)` Gets raw field value by tag.
`char`	`getChar(int tag)` Gets field value by tag.
`<T> T`	`getCustomComposite(int tag, T ref)` Gets custom composite field value by tag.
`ScaledDecimal`	`getDecimal(int tag)` Gets field value by tag.
`ScaledDecimal`	`getDecimal(int tag, ScaledDecimal ref)` Gets field value by tag.
`IGroup`	`getGroup(int tag)` Gets repeating group.
`int`	`getInt(int tag)` Gets field value by tag.
`long`	`getLong(int tag)` Gets field value by tag.
`MonthYear`	`getMonthYear(int tag)` Gets date field value by tag.
`MonthYear`	`getMonthYear(int tag, MonthYear ref)` Gets date field value by tag.
`IFieldSet`	`getParent()` Returns field set parent.
`short`	`getShort(int tag)` Gets field value by tag.
`<T> T`	`getStatelessComposite(int tag, Class<T> clazz)` Gets new instance of the stateless composite bound to the given field.
`String`	`getString(int tag)` Gets field value by tag.
`SbeTimestamp`	`getTimestamp(int tag)`
`SbeTimestamp`	`getTimestamp(int tag, SbeTimestamp ref)`
`short`	`getUnsignedByte(int tag)` Gets field value by tag.
`long`	`getUnsignedInt(int tag)` Gets field value by tag.
`BigInteger`	`getUnsignedLong(int tag)` Gets field value by tag.
`int`	`getUnsignedShort(int tag)` Gets field value by tag.
`ValuePtr`	`getValuePtr(int tag)` Gets raw field value by tag.
`byte[]`	`getVarData(int tag)` Gets VarDataField field value by tag.
`int[]`	`groupTags()` Returns ids of number of instances tags of repeating groups, belonging to this field set.
`boolean`	`hasFieldTag(int tag)` Checks if the field set contains fixed-size field with the tag.
`boolean`	`hasGroupTag(int tag)` Checks if the field set contains repeating group with the tag.
`boolean`	`hasTag(int tag)` Checks if the field set contains the tag.
`boolean`	`hasVarDataTag(int tag)` Checks if the field set contains variadic-length field with the tag.
`void`	`init(byte[] data, int offset, int size)` Writes header fields and initialize repeating groups and VarDataField fields.
`boolean`	`isNullDecimal(int tag, ScaledDecimal value)` Checks if the value represents null for the field with the given tag.
`boolean`	`isNullMonthYear(int tag, MonthYear value)` Checks if the value represents null for the field with the given tag.
`boolean`	`isNullStandardComposite(int tag, Object ref)` Checks if the value represents null for the field with the given tag.
`boolean`	`isNullTimestamp(int tag, SbeTimestamp value)` Checks if the value represents null for the field with the given tag.
`void`	`load(byte[] data, int offset, int size, int version)` Loads header fields and initialize repeating groups and VarDataField fields.
`void`	`reset(int tag)` Resets value of the field to its null value if field is optional or to its default value if field is required.
`void`	`setBoolean(int tag, boolean value)` Sets field value by tag.
`void`	`setByte(int tag, byte value)` Sets field value by tag.
`void`	`setByte(int tag, int value)` Sets field value by tag.
`void`	`setBytes(int tag, byte[] value)` Set raw field value by tag.
`void`	`setChar(int tag, char value)` Sets field value by tag.
`<T> void`	`setCustomComposite(int tag, T value)` Sets field value by tag.
`void`	`setDecimal(int tag, ScaledDecimal value)` Sets field value by tag.
`void`	`setInt(int tag, int value)` Sets field value by tag.
`void`	`setLong(int tag, long value)` Sets field value by tag.
`void`	`setMonthYear(int tag, MonthYear value)` Sets field value by tag.
`void`	`setShort(int tag, int value)` Sets field value by tag.
`void`	`setShort(int tag, short value)` Sets field value by tag.
`void`	`setString(int tag, CharSequence value)` Sets field value by tag.
`void`	`setTimestamp(int tag, SbeTimestamp value)`
`void`	`setUnsignedByte(int tag, int value)` Sets field value by tag.
`void`	`setUnsignedByte(int tag, short value)` Sets field value by tag.
`void`	`setUnsignedInt(int tag, long value)` Sets field value by tag.
`void`	`setUnsignedLong(int tag, BigInteger value)` Sets field value by tag.
`void`	`setUnsignedShort(int tag, int value)` Sets field value by tag.
`void`	`setVarData(int tag, byte[] value)` Sets VarDataField field value by tag.
`String`	`tagName(int tag)` Returns name of the given tag.
`String`	`toFixString(char separator)` Returns FIX string representation of the field set.
`String`	`toString(char separator, boolean useTagNames)` Returns string representation of the field set.
`boolean`	`tryGetBoolean(int tag, AtomicBoolean ref)` Gets field value by tag.
`boolean`	`tryGetByte(int tag, AtomicInteger ref)` Gets field value by tag.
`byte[]`	`tryGetBytes(int tag)` Gets raw field value.
`boolean`	`tryGetChar(int tag, AtomicInteger ref)` Gets field value by tag.
`<T> boolean`	`tryGetCustomComposite(int tag, T ref)` Tries to get composite field value by tag.
`boolean`	`tryGetDecimal(int tag, ScaledDecimal ref)` Gets decimal field value by tag.
`IGroup`	`tryGetGroup(int tag)` Gets repeating group.
`boolean`	`tryGetInt(int tag, AtomicInteger ref)` Gets field value by tag.
`boolean`	`tryGetLong(int tag, AtomicLong ref)` Gets field value by tag.
`boolean`	`tryGetMonthYear(int tag, MonthYear o)` Gets date field value by tag.
`boolean`	`tryGetShort(int tag, AtomicInteger ref)` Gets field value by tag.
`String`	`tryGetString(int tag)` Gets field value by tag.
`boolean`	`tryGetTimestamp(int tag, SbeTimestamp ref)`
`boolean`	`tryGetUnsignedByte(int tag, AtomicInteger ref)` Gets field value by tag.
`boolean`	`tryGetUnsignedInt(int tag, AtomicLong ref)` Gets field value by tag.
`BigInteger`	`tryGetUnsignedLong(int tag)` Gets field value by tag.
`boolean`	`tryGetUnsignedShort(int tag, AtomicInteger ref)` Gets field value by tag.
`boolean`	`tryGetValuePtr(int tag, ValuePtr ref)` Gets raw field value.
`byte[]`	`tryGetVarData(int tag)` Gets VarDataField field value.

- Field Detail
  - DefaultSeparator
```
static final char DefaultSeparator
```
    See Also:
    
    Constant Field Values
- Method Detail
  - load
```
void load(byte[] data,
          int offset,
          int size,
          int version)
```
    Loads header fields and initialize repeating groups and VarDataField fields.
    
    Parameters:
    
    data - byte array, which contains field set data
    
    offset - field set offset in the buffer
    
    size - size of the buffer, available for field set
    
    version - version of the field set in the schema
  - init
```
void init(byte[] data,
          int offset,
          int size)
```
    Writes header fields and initialize repeating groups and VarDataField fields.
    
    Parameters:
    
    data - byte array, which contains field set data
    
    offset - field set offset in the buffer
    
    size - size of the buffer, available for field set
  - contains
```
boolean contains(int tag)
```
    Returns true if field belongs to field set and has not null value.
    
    Parameters:
    
    tag - field id
    
    Returns:
    
    true if field belongs to field set and has not null value, false otherwise.
  - fieldTags
```
int[] fieldTags()
```
    Returns ids of all fields
    
    Returns:
    
    list of field tags
  - groupTags
```
int[] groupTags()
```
    Returns ids of number of instances tags of repeating groups, belonging to this field set. Note: if the message has no groups, then it will return empty array, not null.
    
    Returns:
    
    ids of number of instances tags of repeating groups.
  - dataTags
```
int[] dataTags()
```
    Returns ids of number of instances tags of variadic-length fields, belonging to this field set. Note: if the message has no variadic-length fields, then it will return empty array, not null.
    
    Returns:
    
    ids of number of instances tags of varidaic-length fields.
  - tagName
```
String tagName(int tag)
```
    Returns name of the given tag. The tag name is extracted from the message template. If such a name missed the string representation of the tag id returned.
    
    Parameters:
    
    tag - Tag ID of the tag.
    
    Returns:
    
    Name of the tag.
  - getBoolean
```
boolean getBoolean(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into boolean type (up to 1 byte).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    boolean value of the field
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if requested field cannot be casted to boolean
  - getChar
```
char getChar(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into char type (up to 1 byte).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    char value of the field
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if requested field cannot be casted to char
  - getByte
```
byte getByte(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into byte type (up to 1 byte).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    byte value of the field
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if requested field cannot be casted to byte
  - getUnsignedByte
```
short getUnsignedByte(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into byte type (up to 1 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    byte value of the field
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if requested field cannot be casted to byte
  - getShort
```
short getShort(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into short type (up to 2 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    short value of the field
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if requested field cannot be casted to short
  - getUnsignedShort
```
int getUnsignedShort(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into short type (up to 2 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    short value of the field
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if requested field cannot be casted to short
  - getInt
```
int getInt(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into integer type (up to 4 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    integer value of the field
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if requested field cannot be casted to integer
  - getUnsignedInt
```
long getUnsignedInt(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into integer type (up to 4 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    integer value of the field
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if requested field cannot be casted to integer
  - getLong
```
long getLong(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into long type (up to 8 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    long value of the field
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet
    
    TypeCastException - if requested field cannot be casted to long
  - getUnsignedLong
```
BigInteger getUnsignedLong(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into long type (up to 8 bytes). Creates new BigInteger object.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    long value of the field
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet
    
    TypeCastException - if requested field cannot be casted to long
  - getString
```
String getString(int tag)
```
    Gets field value by tag. Any type, except complex not-embedded types, is able to cast to String. Creates new String object.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    String representation of the field
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet
    
    TypeCastException - if requested field cannot be casted to String
  - getDecimal
```
ScaledDecimal getDecimal(int tag,
                         ScaledDecimal ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into ScaledDecimal. Fills passed ScaledDecimal object and returns it.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    ref - - variable to store the field value. the function will return this parameter. o cannot be null. Value of o will be rewritten.
    
    Returns:
    
    ScaledDecimal representation of the field
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet
    
    TypeCastException - if requested field cannot be casted to ScaledDecimal
  - getDecimal
```
ScaledDecimal getDecimal(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into ScaledDecimal. Creates new ScaledDecimal object.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    ScaledDecimal representation of the field
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet
    
    TypeCastException - if requested field cannot be casted to ScaledDecimal
  - getMonthYear
```
MonthYear getMonthYear(int tag,
                       MonthYear ref)
```
    Gets date field value by tag. Fills passed MonthYear object.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    ref - - variable to store the field value. the function will return this parameter. o cannot be null. Value of o will be rewritten.
    
    Returns:
    
    MonthYear representation of the field
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet
    
    TypeCastException - if requested field cannot be casted to MonthYear
  - getMonthYear
```
MonthYear getMonthYear(int tag)
```
    Gets date field value by tag. Creates new MonthYear object.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    MonthYear representation of the field.
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet
    
    TypeCastException - if requested field cannot be casted to MonthYear
  - getVarData
```
byte[] getVarData(int tag)
```
    Gets VarDataField field value by tag. Creates new byte array.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    Byte array with data of the field.
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet.
    
    TypeCastException - if requested field is not variable length data field.
  - getBytes
```
byte[] getBytes(int tag)
```
    Gets raw field value by tag. Can be applied to any field type. Creates new byte array.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    Byte array with data of the field. Data was copied into byte array.
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet.
  - getValuePtr
```
ValuePtr getValuePtr(int tag)
```
    Gets raw field value by tag. Can be applied to any field type. Creates new ValuePtr object.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    ValuePtr class which references to data of the field.
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet.
  - setBoolean
```
void setBoolean(int tag,
                boolean value)
```
    Sets field value by tag. Executes only for fields, which are able to contain boolean type (up to 1 byte).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setChar
```
void setChar(int tag,
             char value)
```
    Sets field value by tag. Executes only for fields, which are able to contain char type (up to 1 byte).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setByte
```
void setByte(int tag,
             byte value)
```
    Sets field value by tag. Executes only for fields, which are able to contain byte type (up to 1 byte).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setByte
```
void setByte(int tag,
             int value)
```
    Sets field value by tag. Executes only for fields, which are able to contain byte type (up to 1 byte).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setUnsignedByte
```
void setUnsignedByte(int tag,
                     short value)
```
    Sets field value by tag. Executes only for fields, which are able to contain unsigned byte type (up to 1 byte).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setUnsignedByte
```
void setUnsignedByte(int tag,
                     int value)
```
    Sets field value by tag. Executes only for fields, which are able to contain unsigned byte type (up to 1 byte).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setShort
```
void setShort(int tag,
              short value)
```
    Sets field value by tag. Executes only for fields, which are able to contain short type (up to 2 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setShort
```
void setShort(int tag,
              int value)
```
    Sets field value by tag. Executes only for fields, which are able to contain short type (up to 2 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setUnsignedShort
```
void setUnsignedShort(int tag,
                      int value)
```
    Sets field value by tag. Executes only for fields, which are able to contain unsigned short type (up to 2 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setInt
```
void setInt(int tag,
            int value)
```
    Sets field value by tag. Executes only for fields, which are able to contain int type (up to 4 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setUnsignedInt
```
void setUnsignedInt(int tag,
                    long value)
```
    Sets field value by tag. Executes only for fields, which are able to contain unsigned int type (up to 4 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setLong
```
void setLong(int tag,
             long value)
```
    Sets field value by tag. Executes only for fields, which are able to contain long type (up to 8 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setUnsignedLong
```
void setUnsignedLong(int tag,
                     BigInteger value)
```
    Sets field value by tag. Executes only for fields, which are able to contain unsigned long type (up to 8 bytes).
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setString
```
void setString(int tag,
               CharSequence value)
```
    Sets field value by tag. Executes only for fields, which are able to contain string type.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setDecimal
```
void setDecimal(int tag,
                ScaledDecimal value)
```
    Sets field value by tag. Executes only for fields, which are able to contain ScaledDecimal type.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setMonthYear
```
void setMonthYear(int tag,
                  MonthYear value)
```
    Sets field value by tag. Executes only for fields, which are able to contain MonthYear type.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - setVarData
```
void setVarData(int tag,
                byte[] value)
```
    Sets VarDataField field value by tag.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet
    
    TypeCastException - if requested field is not variable length data field
  - setBytes
```
void setBytes(int tag,
              byte[] value)
```
    Set raw field value by tag. Can be applied to any field type.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    value - - value of the field.
    
    Throws:
    
    TagNotFoundException - if field is absent in the FieldSet.
  - tryGetBoolean
```
boolean tryGetBoolean(int tag,
                      AtomicBoolean ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into boolean type (up to 1 byte). Fills passed AtomicBoolean object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    ref - - reference type variable to store return value of the field
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value, or cannot be casted to boolean type
  - tryGetChar
```
boolean tryGetChar(int tag,
                   AtomicInteger ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into char type (up to 1 byte). Fills passed AtomicInteger object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    ref - - reference type variable to store return value of the field
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value, or cannot be casted to char type
  - tryGetByte
```
boolean tryGetByte(int tag,
                   AtomicInteger ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into byte type (up to 1 byte). Fills passed AtomicInteger object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    ref - - reference type variable to store return value of the field
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value, or cannot be casted to byte type
  - tryGetUnsignedByte
```
boolean tryGetUnsignedByte(int tag,
                           AtomicInteger ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into unsigned byte type (up to 1 byte). Fills passed AtomicInteger object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    ref - - reference type variable to store return value of the field
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value, or cannot be casted to unsigned byte type
  - tryGetShort
```
boolean tryGetShort(int tag,
                    AtomicInteger ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into short type (up to 2 bytes). Fills passed AtomicInteger object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    ref - - reference type variable to store return value of the field
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value, or cannot be casted to short type
  - tryGetUnsignedShort
```
boolean tryGetUnsignedShort(int tag,
                            AtomicInteger ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into unsigned short type (up to 2 bytes). Fills passed AtomicInteger object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    ref - - reference type variable to store return value of the field
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value, or cannot be casted to unsigned short type
  - tryGetInt
```
boolean tryGetInt(int tag,
                  AtomicInteger ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into int type (up to 4 bytes). Fills passed AtomicInteger object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    ref - - reference type variable to store return value of the field
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value, or cannot be casted to int type
  - tryGetUnsignedInt
```
boolean tryGetUnsignedInt(int tag,
                          AtomicLong ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into unsigned int type (up to 4 bytes). Fills passed AtomicLong object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    ref - - reference type variable to store return value of the field
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value, or cannot be casted to unsigned int type
  - tryGetLong
```
boolean tryGetLong(int tag,
                   AtomicLong ref)
```
    Gets field value by tag. Returns only fields, which are able to fit into long type (up to 8 bytes). Fills passed AtomicLong object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    ref - - reference type variable to store return value of the field
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value, or cannot be casted to long type
  - tryGetUnsignedLong
```
BigInteger tryGetUnsignedLong(int tag)
```
    Gets field value by tag. Returns only fields, which are able to fit into unsigned long type (up to 8 bytes). Creates new BigInteger object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    Returns:
    
    null if tag is absent, or is optional and has NULL value, or cannot be casted to unsigned long type. Otherwise, returns unsigned long representation of the field
  - tryGetString
```
String tryGetString(int tag)
```
    Gets field value by tag. Any type, except complex not-embedded types, is able to casted to String. Creates new BigInteger object.
    
    Parameters:
    
    tag - - integer tag id of the field
    
    Returns:
    
    null if tag is absent, or is optional and has NULL value, or cannot be cast to String. Otherwise, returns string representation of the field
  - tryGetDecimal
```
boolean tryGetDecimal(int tag,
                      ScaledDecimal ref)
```
    Gets decimal field value by tag. Fills passed ScaledDecimal object.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    ref - - variable to store the field value. o cannot be null. Value of o will be rewritten.
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value or cannot be cast to ScaledDecimal type.
  - tryGetMonthYear
```
boolean tryGetMonthYear(int tag,
                        MonthYear o)
```
    Gets date field value by tag. Fills passed MonthYear object.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    o - - variable to store the field value. o cannot be null. Value of o will be rewritten.
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value or cannot be cast to MonthYear type.
  - getGroup
```
IGroup getGroup(int tag)
```
    Gets repeating group. Returns existing group object, so subsequent calls to getGroup with the same tag will return same object.
    
    Parameters:
    
    tag - - integer tag id of the group.
    
    Returns:
    
    repeating group
    
    Throws:
    
    TagNotFoundException - if there is no such field or group
    
    TypeCastException - if requested tagged object is not a group
  - tryGetGroup
```
IGroup tryGetGroup(int tag)
```
    Gets repeating group. Returns existing group object, so subsequent calls to getGroup with the same tag will return same object.
    
    Parameters:
    
    tag - - integer tag id of the group.
    
    Returns:
    
    group instance for tag or null if there is no such tag, or tag is not group
  - tryGetVarData
```
byte[] tryGetVarData(int tag)
```
    Gets VarDataField field value. Creates new byte array.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    byte array with data of the field or nullif there is no such tag, or tag is not group
  - tryGetBytes
```
byte[] tryGetBytes(int tag)
```
    Gets raw field value. Creates new byte array.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    Returns:
    
    byte array with data of the field or null if there is no such tag
  - tryGetValuePtr
```
boolean tryGetValuePtr(int tag,
                       ValuePtr ref)
```
    Gets raw field value. Fills passed ValuePtr object.
    
    Parameters:
    
    tag - - integer tag id of the field.
    
    ref - - object to store value.
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value
  - reset
```
void reset(int tag)
```
    Resets value of the field to its null value if field is optional or to its default value if field is required.
    
    Parameters:
    
    tag - - integer tag id of the field.
  - toFixString
```
String toFixString(char separator)
```
    Returns FIX string representation of the field set. Note: by default toString() is equal to call toFixString(DefaultSeparator)
    
    Parameters:
    
    separator - for fields
    
    Returns:
    
    FIX string representation of the field set
  - toString
```
String toString(char separator,
                boolean useTagNames)
```
    Returns string representation of the field set. This method allows to format the field set in key-value format. The result can be a FIX-compliant string or more human-readable representation that uses tag names to identify fields instead of numeric tag identifiers. Note: In a case of the Message when the useTagnames=true parameter is used, the service fields (with tags of 8, 9, 10 and 35) are omitted and the message semantic name is moved to begin of the result string. Also, minor improvements for fields delimitation are applied.
    
    Parameters:
    
    useTagNames - true to use tag names, false - to use tag identifiers.
    
    separator - for fields
    
    Returns:
    
    String representation of the field set
  - getParent
```
IFieldSet getParent()
```
    Returns field set parent. For Message always returns null; For message's groups returns Message instance For sub-groups returns their owner.
    
    Returns:
    
    parent of the field set
  - hasTag
```
boolean hasTag(int tag)
```
    Checks if the field set contains the tag. Returns true if definition of the field set contains given tag. There is no matter of field kind (fixed-size field, group or variadic-length data).
    
    Parameters:
    
    tag - tag to check.
    
    Returns:
    
    true if the field set definition has the tag.
  - hasFieldTag
```
boolean hasFieldTag(int tag)
```
    Checks if the field set contains fixed-size field with the tag. Returns true if definition of the field set contains fixed-size field with the given tag. There is no matter of the actual field value: i.e. is it null or not null.
    
    Parameters:
    
    tag - tag to check.
    
    Returns:
    
    true if the field set definition has the field tag.
  - hasGroupTag
```
boolean hasGroupTag(int tag)
```
    Checks if the field set contains repeating group with the tag. Returns true if definition of the field set contains repeating group with the given tag.
    
    Parameters:
    
    tag - tag to check.
    
    Returns:
    
    true if the field set definition has the repeating group tag.
  - hasVarDataTag
```
boolean hasVarDataTag(int tag)
```
    Checks if the field set contains variadic-length field with the tag. Returns true if definition of the field set contains variadic-length field with the given tag.
    
    Parameters:
    
    tag - tag to check.
    
    Returns:
    
    true if the field set definition has the variadic-length field tag.
  - getTimestamp
```
SbeTimestamp getTimestamp(int tag)
```
  - getTimestamp
```
SbeTimestamp getTimestamp(int tag,
                          SbeTimestamp ref)
```
  - tryGetTimestamp
```
boolean tryGetTimestamp(int tag,
                        SbeTimestamp ref)
```
  - setTimestamp
```
void setTimestamp(int tag,
                  SbeTimestamp value)
```
  - createNullDecimal
```
ScaledDecimal createNullDecimal(int tag,
                                ScaledDecimal ref)
```
    Create null value for the given field.
    
    Parameters:
    
    tag - Tag of the field which null value is requested.
    
    ref - Object to fill (optional)
    
    Returns:
    
    Input object
  - isNullDecimal
```
boolean isNullDecimal(int tag,
                      ScaledDecimal value)
```
    Checks if the value represents null for the field with the given tag.
    
    Parameters:
    
    tag - Tag of the field.
    
    value - Value to check.
    
    Returns:
    
    true if the value means null for the given field.
  - createNullMonthYear
```
MonthYear createNullMonthYear(int tag,
                              MonthYear ref)
```
    Creates null MonthYear object.
    
    Parameters:
    
    tag - field of the MonthYear type.
    
    ref - object to fill with null data.
    
    Returns:
    
    input object filled by null data.
  - isNullMonthYear
```
boolean isNullMonthYear(int tag,
                        MonthYear value)
```
    Checks if the value represents null for the field with the given tag.
    
    Parameters:
    
    tag - Tag of the field.
    
    value - Value to check.
    
    Returns:
    
    true if the value means null for the given field.
  - createNullTimestamp
```
SbeTimestamp createNullTimestamp(int tag,
                                 SbeTimestamp ref)
```
    Creates null MonthYear object.
    
    Parameters:
    
    tag - field of the MonthYear type.
    
    ref - object to fill with null data.
    
    Returns:
    
    input object filled by null data.
  - isNullTimestamp
```
boolean isNullTimestamp(int tag,
                        SbeTimestamp value)
```
    Checks if the value represents null for the field with the given tag.
    
    Parameters:
    
    tag - Tag of the field.
    
    value - Value to check.
    
    Returns:
    
    true if the value means null for the given field.
  - createEmptyStandardComposite
```
Object createEmptyStandardComposite(int tag,
                                    Object ref)
```
    Creates null object of the standard composite type.
    
    Parameters:
    
    tag - Tag of the field.
    
    ref - Object to fill with null value. The object type must correspond to the field type.
    
    Returns:
    
    the input object filled with null data.
  - isNullStandardComposite
```
boolean isNullStandardComposite(int tag,
                                Object ref)
```
    Checks if the value represents null for the field with the given tag.
    
    Parameters:
    
    tag - Tag of the field.
    
    ref - Value to check.
    
    Returns:
    
    true if the value means null for the given field.
  - getCustomComposite
```
<T> T getCustomComposite(int tag,
                         T ref)
```
    Gets custom composite field value by tag. Fills object passed via ref argument.
    
    Type Parameters:
    
    T - Type of the custom composite.
    
    Parameters:
    
    tag - Tag of teh field
    
    ref - Custom composite object to fill.
    
    Returns:
    
    The ref value.
  - tryGetCustomComposite
```
<T> boolean tryGetCustomComposite(int tag,
                                  T ref)
```
    Tries to get composite field value by tag. Fills passed object.
    
    Type Parameters:
    
    T - Type of the custom composite
    
    Parameters:
    
    tag - Integer tag id of the field.
    
    ref - Variable to store the field value. ref cannot be null. Value of ref will be rewritten.
    
    Returns:
    
    false if tag is absent, or is optional and has NULL value or cannot be cast to ScaledDecimal type.
  - setCustomComposite
```
<T> void setCustomComposite(int tag,
                            T value)
```
    Sets field value by tag. Executes only for fields, which are able to contain the custom composite type.
    
    Type Parameters:
    
    T - Type of the custom composite
    
    Parameters:
    
    tag - Integer tag id of the field.
    
    value - Value of the field.
    
    Throws:
    
    TagNotFoundException - if field is not found
    
    TypeCastException - if value cannot be casted to field type
  - getStatelessComposite
```
<T> T getStatelessComposite(int tag,
                            Class<T> clazz)
```
    Gets new instance of the stateless composite bound to the given field.
    
    Type Parameters:
    
    T - Type of the sutom composite.
    
    Parameters:
    
    tag - - ID of the field.
    
    clazz - Class of the composite type.
    
    Returns:
    
    Instance of the composite that is bound to the given field set and field.

Interface IFieldSet

Field Summary

Method Summary

Field Detail

DefaultSeparator

Method Detail

load

init

contains

fieldTags

groupTags

dataTags

tagName

getBoolean

getChar

getByte

getUnsignedByte

getShort

getUnsignedShort

getInt

getUnsignedInt

getLong

getUnsignedLong

getString

getDecimal

getDecimal

getMonthYear

getMonthYear

getVarData

getBytes

getValuePtr

setBoolean

setChar

setByte

setByte

setUnsignedByte

setUnsignedByte

setShort

setShort

setUnsignedShort

setInt

setUnsignedInt

setLong

setUnsignedLong

setString

setDecimal

setMonthYear

setVarData

setBytes

tryGetBoolean

tryGetChar

tryGetByte

tryGetUnsignedByte

tryGetShort

tryGetUnsignedShort

tryGetInt

tryGetUnsignedInt

tryGetLong

tryGetUnsignedLong

tryGetString

tryGetDecimal

tryGetMonthYear

getGroup

tryGetGroup

tryGetVarData

tryGetBytes

tryGetValuePtr

reset

toFixString

toString

getParent

hasTag

hasFieldTag

hasGroupTag

hasVarDataTag

getTimestamp

getTimestamp

tryGetTimestamp

setTimestamp

createNullDecimal