FieldDefinition (Java FIX Engine Package 2.14.8 API)

java.lang.Object
- biz.onixs.fix.dictionary.FieldDefinition

public class FieldDefinition
extends Object

FIX field low-level definition.

Constructor Summary

Constructors
Constructor and Description

FieldDefinition(int tag, boolean required, String tagName, GroupDefinition grpDef)
Constructor.

Constructors
Constructor and Description
`FieldDefinition(int tag, boolean required, String tagName, GroupDefinition grpDef)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`GroupDefinition`	`getGroupDefinition()` Returns FIX repeating group low-level definition if the FIX field define a repeating group otherwise `null`.
`int`	`getGroupIndex()` Returns the index of FIX repeating group (if the FIX field defines a repeating group) in the parent container (FIX message or repeating group).
`int`	`getIndex()` Returns the index of FIX field in the parent container (FIX message or repeating group).
`int`	`getTag()` Returns the FIX fields tag number.
`byte[]`	`getTagAsBytes()` Returns byte array representation of the FIX fields tag number.
`String`	`getTagName()` Returns string representation of the FIX fields tag name.
`byte[]`	`getTagNameBytes()` Returns byte array representation of the FIX fields tag name.
`int`	`hashCode()`
`void`	`init()` Initializes internal state of the object after initialization/modification.
`boolean`	`isGroupDefined()` Returns whether the FIX field defines a FIX repeating group.
`boolean`	`isRequired()` Returns whether the FIX field is required.
`void`	`setGroupDefinition(GroupDefinition groupDefinition)` Sets the FIX repeating group low-level definition so the FIX field will define the repeating group.
`void`	`setName(String name)` Sets name of the FIX field.
`void`	`setRequired(boolean required)` Sets whether the FIX field is required.

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

- Constructor Detail
  - FieldDefinition
```
public FieldDefinition(int tag,
                       boolean required,
                       String tagName,
                       GroupDefinition grpDef)
```
    Constructor.
    
    Parameters:
    
    tag - tag number
    
    required - whether field is requred
    
    tagName - tag name
    
    grpDef - FIX repeating group low-level definition if the FIX field defines a repeating group
- Method Detail
  - getGroupDefinition
```
public GroupDefinition getGroupDefinition()
```
    Returns FIX repeating group low-level definition if the FIX field define a repeating group otherwise null.
    
    Returns:
    
    FIX repeating group low-level definition if the FIX field define a repeating group otherwise null
  - setGroupDefinition
```
public void setGroupDefinition(GroupDefinition groupDefinition)
```
    Sets the FIX repeating group low-level definition so the FIX field will define the repeating group.
    
    Parameters:
    
    groupDefinition - repeating group definition
  - getGroupIndex
```
public int getGroupIndex()
```
    Returns the index of FIX repeating group (if the FIX field defines a repeating group) in the parent container (FIX message or repeating group).
    
    Returns:
    
    the index of FIX field
  - getIndex
```
public int getIndex()
```
    Returns the index of FIX field in the parent container (FIX message or repeating group).
    
    Returns:
    
    the index of FIX field
  - getTag
```
public int getTag()
```
    Returns the FIX fields tag number.
    
    Returns:
    
    the FIX fields tag number
  - getTagAsBytes
```
public byte[] getTagAsBytes()
```
    Returns byte array representation of the FIX fields tag number.
    
    Returns:
    
    byte array representation of the FIX fields tag number
  - getTagName
```
public String getTagName()
```
    Returns string representation of the FIX fields tag name.
    
    Returns:
    
    string representation of the FIX fields tag name
  - getTagNameBytes
```
public byte[] getTagNameBytes()
```
    Returns byte array representation of the FIX fields tag name.
    
    Returns:
    
    byte array representation of the FIX fields tag name
  - isGroupDefined
```
public boolean isGroupDefined()
```
    Returns whether the FIX field defines a FIX repeating group.
    
    Returns:
    
    whether the FIX field defines a FIX repeating group
  - isRequired
```
public boolean isRequired()
```
    Returns whether the FIX field is required.
    
    Returns:
    
    whether the FIX field is required
  - setRequired
```
public void setRequired(boolean required)
```
    Sets whether the FIX field is required.
    
    Parameters:
    
    required - whether the FIX field is required
  - init
```
public void init()
```
    Initializes internal state of the object after initialization/modification.
  - setName
```
public void setName(String name)
```
    Sets name of the FIX field.
    
    Parameters:
    
    name - name of field
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class FieldDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FieldDefinition

Method Detail

getGroupDefinition

setGroupDefinition

getGroupIndex

getIndex

getTag

getTagAsBytes

getTagName

getTagNameBytes

isGroupDefined

isRequired

setRequired

init

setName

equals

hashCode