Version (Java FIX Engine Package 2.13.5 API)

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

All Implemented Interfaces:

Serializable, Comparable<Version>
```
public final class Version
extends Object
implements Serializable, Comparable<Version>
```
Financial Information eXchange (FIX) protocol version.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Version`	`FIX40` Version 4.0
`static Version`	`FIX41` Version 4.1
`static Version`	`FIX42` Version 4.2
`static Version`	`FIX43` Version 4.3
`static Version`	`FIX44` Version 4.4
`static Version`	`FIX50` Version 5.0
`static Version`	`FIX50_SP1` Version 5.0 SP1
`static Version`	`FIX50_SP2` Version 5.0 SP2
`static Version`	`FIX50_SP2_LATEST` Version 5.0 SP2 Latest
`static Version`	`UNKNOWN` Unknown FIX version.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkUsable()` Checks whether this version is initialized and can be used.
`int`	`compareTo(Version o)`
`static Set<Version>`	`getAllBaseVersions()` Returns base FIX versions.
`static List<Version>`	`getAllVersions()` Returns all base and dialect FIX versions.
`ApplVerId`	`getApplVerId()` Returns ApplVerID(1128) value.
`Version`	`getBaseVersion()` Returns base FIX version if this is dialect or itself if not.
`String`	`getBeginString()` Returns the value of the BeginString (tag=8) field.
`static Version`	`getByApplVerId(ApplVerId applVerId)` Returns FIX version by the ApplVerID(1128) value.
`static Version`	`getByBeginString(String beginString)` Returns instance by FIX begin string.
`static Version`	`getByBeginStringBytesStrict(byte[] buffer, int offset, int length)` Returns FIX version by the begin string in the buffer.
`static Version`	`getByDefaultApplVerId(ApplVerId defaultApplVerID)` Returns FIX version by the DefaultApplVerID(1137) value.
`static Version`	`getById(String id)` Returns instance by base or dialect FIX version id.
`static Version`	`getByIdStrict(String id)` Returns instance by base or dialect FIX version id.
`static Version`	`getByNumber(String number)` Returns instance by FIX version number.
`byte[]`	`getBytes()` Returns FIX string as a byte array.
`ApplVerId`	`getDefaultApplVerId()` Returns DefaultApplVerID(1137) value.
`static Version`	`getDialectVersion(Version baseVersion, String id)` Returns dialect FIX version with the specified base FIX version and dialect name.
`String`	`getId()` Returns base or dialect FIX version id.
`String`	`getNumber()` Returns FIX version number.
`boolean`	`isUsable()` Returns whether this version is initialized and can be used.
`String`	`toString()`

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

- Field Detail
  - UNKNOWN
```
public static final Version UNKNOWN
```
    Unknown FIX version.
  - FIX40
```
public static final Version FIX40
```
    Version 4.0
  - FIX41
```
public static final Version FIX41
```
    Version 4.1
  - FIX42
```
public static final Version FIX42
```
    Version 4.2
  - FIX43
```
public static final Version FIX43
```
    Version 4.3
  - FIX44
```
public static final Version FIX44
```
    Version 4.4
  - FIX50
```
public static final Version FIX50
```
    Version 5.0
  - FIX50_SP1
```
public static final Version FIX50_SP1
```
    Version 5.0 SP1
  - FIX50_SP2
```
public static final Version FIX50_SP2
```
    Version 5.0 SP2
  - FIX50_SP2_LATEST
```
public static final Version FIX50_SP2_LATEST
```
    Version 5.0 SP2 Latest
- Method Detail
  - getAllBaseVersions
```
public static Set<Version> getAllBaseVersions()
```
    Returns base FIX versions.
    
    Returns:
    
    base FIX versions
  - getAllVersions
```
public static List<Version> getAllVersions()
```
    Returns all base and dialect FIX versions.
    
    Returns:
    
    all FIX versions
  - getApplVerId
```
public ApplVerId getApplVerId()
```
    Returns ApplVerID(1128) value.
    
    Returns:
    
    ApplVerID(1128) value
  - getBeginString
```
public String getBeginString()
```
    Returns the value of the BeginString (tag=8) field. Example: FIX.4.2.
    
    Returns:
    
    begin string value
  - getBytes
```
public byte[] getBytes()
```
    Returns FIX string as a byte array. See also getBeginString().
    
    Returns:
    
    FIX string byte array
  - getDefaultApplVerId
```
public ApplVerId getDefaultApplVerId()
```
    Returns DefaultApplVerID(1137) value.
    
    Returns:
    
    DefaultApplVerID(1137) value
  - getId
```
public String getId()
```
    Returns base or dialect FIX version id. Example: FIX.4.2 Example: Lava
    
    Returns:
    
    version name
  - getNumber
```
public String getNumber()
```
    Returns FIX version number. For dialects the base version number is returned. Example: 4.2.
    
    Returns:
    
    FIX version number
  - isUsable
```
public boolean isUsable()
```
    Returns whether this version is initialized and can be used.
    
    Returns:
    
    whether this version is initialized and can be used
  - checkUsable
```
public void checkUsable()
```
    Checks whether this version is initialized and can be used. If this is not the case the exception is thrown.
    
    Throws:
    
    VersionNotUsable - if this version is not initialized or can not be used.
  - getByApplVerId
```
public static Version getByApplVerId(ApplVerId applVerId)
```
    Returns FIX version by the ApplVerID(1128) value.
    
    Parameters:
    
    applVerId - ApplVerID(1128) value
    
    Returns:
    
    FIX version
  - getByBeginString
```
public static Version getByBeginString(String beginString)
```
    Returns instance by FIX begin string.
    
    Parameters:
    
    beginString - FIX begin string
    
    Returns:
    
    Version object instance
  - getByBeginStringBytesStrict
```
public static Version getByBeginStringBytesStrict(byte[] buffer,
                                                  int offset,
                                                  int length)
```
    Returns FIX version by the begin string in the buffer. The sample begin string is "FIX.4.4".
    
    Parameters:
    
    buffer - source buffer
    
    offset - offset in the buffer
    
    length - length
    
    Returns:
    
    FIX version
  - getByDefaultApplVerId
```
public static Version getByDefaultApplVerId(ApplVerId defaultApplVerID)
```
    Returns FIX version by the DefaultApplVerID(1137) value.
    
    Parameters:
    
    defaultApplVerID - DefaultApplVerID(1137) value
    
    Returns:
    
    FIX version
  - getByIdStrict
```
public static Version getByIdStrict(String id)
```
    Returns instance by base or dialect FIX version id.
    
    Parameters:
    
    id - FIX version name or dialect name. Example: FIX.4.2. Example: Lava.
    
    Returns:
    
    version object if found
    
    Throws:
    
    RuntimeException - if not found
  - getById
```
public static Version getById(String id)
```
    Returns instance by base or dialect FIX version id.
    
    Parameters:
    
    id - FIX version name or dialect name. Example: FIX.4.2. Example: Lava.
    
    Returns:
    
    instance or UNKNOWN if not found
  - getByNumber
```
public static Version getByNumber(String number)
```
    Returns instance by FIX version number.
    
    Parameters:
    
    number - FIX version number. Example: 4.2
    
    Returns:
    
    Version object instance
  - getDialectVersion
```
public static Version getDialectVersion(Version baseVersion,
                                        String id)
```
    Returns dialect FIX version with the specified base FIX version and dialect name. The new instance is created if it is not found. This method is for internal usage. Please use getById(String) if you just need to get a version by name.
    
    Parameters:
    
    baseVersion - base FIX version
    
    id - dialect id
    
    Returns:
    
    dialect FIX version
  - compareTo
```
public int compareTo(Version o)
```
    Specified by:
    
    compareTo in interface Comparable<Version>
  - getBaseVersion
```
public Version getBaseVersion()
```
    Returns base FIX version if this is dialect or itself if not.
    
    Returns:
    
    base version
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Version

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN

FIX40

FIX41

FIX42

FIX43

FIX44

FIX50

FIX50_SP1

FIX50_SP2

FIX50_SP2_LATEST

Method Detail

getAllBaseVersions

getAllVersions

getApplVerId

getBeginString

getBytes

getDefaultApplVerId

getId

getNumber

isUsable

checkUsable

getByApplVerId

getByBeginString

getByBeginStringBytesStrict

getByDefaultApplVerId

getByIdStrict

getById

getByNumber

getDialectVersion

compareTo

getBaseVersion

toString