VersionHelper (Java API Reference for Oracle? Coherence Community Edition)

java.lang.Object
- com.tangosol.util.VersionHelper

```
public class VersionHelper
extends Object
```
A utility class for working with Coherence versions.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`VERSION_12_2_1_4` The encoded 12.2.1.4.0 and 20 versions.
`static int`	`VERSION_12_2_1_4_20`
`static int`	`VERSION_12_2_1_4_21`
`static int`	`VERSION_12_2_1_6` The encoded 12.2.1.6.0 and 6 versions.
`static int`	`VERSION_12_2_1_6_6`
`static int`	`VERSION_12_2_1_6_7`
`static int`	`VERSION_14_1_1_0` The encoded 14.1.1.0.0 and 16 versions.
`static int`	`VERSION_14_1_1_0_16`
`static int`	`VERSION_14_1_1_0_17`
`static int`	`VERSION_14_1_1_2206` The encoded 14.1.1.2206.0, 6 and 7 versions.
`static int`	`VERSION_14_1_1_2206_6`
`static int`	`VERSION_14_1_1_2206_7`
`static int`	`VERSION_14_1_2_0` The encoded 14.1.2.0.0 version.
`static int`	`VERSION_23_09` The encoded CE 23.09.0 and 1 versions.
`static int`	`VERSION_23_09_1`

Constructor Summary

Constructors
Constructor and Description

VersionHelper()

Constructors
Constructor and Description
`VersionHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`encodeVersion(int nYear, int nMonth, int nPatch)` Convert the version elements into a single integer value.
`static int`	`encodeVersion(int nMajor, int nMinor, int nMicro, int nPatchSet, int nPatch)` Convert the version elements into a single integer value.
`static int`	`getVersionPrefix(int nYear, int nMonth)` Return the version prefix for a given yy-mm version.
`static boolean`	`isCalendarVersion(int nVersion)` Return `true` if the provided part of the version could represent a year.
`static boolean`	`isPatchCompatible(int nRequired, int nActual)` Return `true` iff the required and the actual versions provided have the identical base version, and the actual patch version is greater or equal to the required patch version.
`static boolean`	`isVersionCompatible(int nRequired, int nActual)` Return `true` iff the actual version provided is greater than or equal to the required version.
`static void`	`main(String[] args)` Compare two version strings for compatability.
`static int`	`parseVersion(String sVersion)` Parse the specified version string and generate an internal integer representation.
`static void`	`resolveFusionAppsPatchSet(int[] anVersion)` This method will map Fusion Apps versions to the correct Coherence version.
`static int`	`resolveFusionAppsPatchSet(int nMajor, int nMinor, int nMicro, int nPatchSet)` Return the actual patch set value to use for a given version.
`static int[]`	`toVersionArray(String sVersion)` Create an array of version elements, where index 0 is "major", 1 is "minor", ... 4 is "patch".
`static String`	`toVersionString(int nVersion, boolean fIncludePrefix)` Create a string representation of the specified version in internal encoding.

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

- Field Detail
  - VERSION_23_09
```
public static final int VERSION_23_09
```
    The encoded CE 23.09.0 and 1 versions.
  - VERSION_23_09_1
```
public static final int VERSION_23_09_1
```
  - VERSION_14_1_1_2206
```
public static final int VERSION_14_1_1_2206
```
    The encoded 14.1.1.2206.0, 6 and 7 versions.
  - VERSION_14_1_1_2206_6
```
public static final int VERSION_14_1_1_2206_6
```
  - VERSION_14_1_1_2206_7
```
public static final int VERSION_14_1_1_2206_7
```
  - VERSION_14_1_2_0
```
public static final int VERSION_14_1_2_0
```
    The encoded 14.1.2.0.0 version.
  - VERSION_14_1_1_0
```
public static final int VERSION_14_1_1_0
```
    The encoded 14.1.1.0.0 and 16 versions.
  - VERSION_14_1_1_0_16
```
public static final int VERSION_14_1_1_0_16
```
  - VERSION_14_1_1_0_17
```
public static final int VERSION_14_1_1_0_17
```
  - VERSION_12_2_1_4
```
public static final int VERSION_12_2_1_4
```
    The encoded 12.2.1.4.0 and 20 versions.
  - VERSION_12_2_1_4_20
```
public static final int VERSION_12_2_1_4_20
```
  - VERSION_12_2_1_4_21
```
public static final int VERSION_12_2_1_4_21
```
  - VERSION_12_2_1_6
```
public static final int VERSION_12_2_1_6
```
    The encoded 12.2.1.6.0 and 6 versions.
  - VERSION_12_2_1_6_6
```
public static final int VERSION_12_2_1_6_6
```
  - VERSION_12_2_1_6_7
```
public static final int VERSION_12_2_1_6_7
```
- Constructor Detail
  - VersionHelper
```
public VersionHelper()
```
- Method Detail
  - encodeVersion
```
public static int encodeVersion(int nYear,
                                int nMonth,
                                int nPatch)
```
    Convert the version elements into a single integer value.
    
    Parameters:
    
    nYear - the version year
    
    nMonth - the version month
    
    nPatch - the version patch
    
    Returns:
    
    the yy-mm-patch version encoded as an int
  - encodeVersion
```
public static int encodeVersion(int nMajor,
                                int nMinor,
                                int nMicro,
                                int nPatchSet,
                                int nPatch)
```
    Convert the version elements into a single integer value.
    
    Parameters:
    
    nMajor - the major version number
    
    nMinor - the minor version number
    
    nMicro - the micro version number
    
    nPatchSet - the patch set version number
    
    nPatch - the patch version number
    
    Returns:
    
    the version encoded as an int
  - getVersionPrefix
```
public static int getVersionPrefix(int nYear,
                                   int nMonth)
```
    Return the version prefix for a given yy-mm version.
    
    Parameters:
    
    nYear - the version year
    
    nMonth - the version month
    
    Returns:
    
    the version prefix
  - isCalendarVersion
```
public static boolean isCalendarVersion(int nVersion)
```
    Return true if the provided part of the version could represent a year.
    
    Parameters:
    
    nVersion - the version part to check
    
    Returns:
    
    true if the provided part of the version could represent a year
  - parseVersion
```
public static int parseVersion(String sVersion)
```
    Parse the specified version string and generate an internal integer representation.
    
    Parameters:
    
    sVersion - the version string to encode
    
    Returns:
    
    the version string encoded to an int
  - toVersionArray
```
public static int[] toVersionArray(String sVersion)
```
    Create an array of version elements, where index 0 is "major", 1 is "minor", ... 4 is "patch".
  - toVersionString
```
public static String toVersionString(int nVersion,
                                     boolean fIncludePrefix)
```
    Create a string representation of the specified version in internal encoding.
  - isVersionCompatible
```
public static boolean isVersionCompatible(int nRequired,
                                          int nActual)
```
    Return true iff the actual version provided is greater than or equal to the required version.
    
    Parameters:
    
    nRequired - the required version in its encoded form
    
    nActual - the actual version in its encoded form
    
    Returns:
    
    true iff the actual version provided is greater than or equal to the required version
  - isPatchCompatible
```
public static boolean isPatchCompatible(int nRequired,
                                        int nActual)
```
    Return true iff the required and the actual versions provided have the identical base version, and the actual patch version is greater or equal to the required patch version.
    
    Parameters:
    
    nRequired - the required version in its encoded form
    
    nActual - the actual version in its encoded form
    
    Returns:
    
    true iff the required and the actual versions provided have the identical base version, and the actual patch version is greater or equal to the required patch version
  - resolveFusionAppsPatchSet
```
public static void resolveFusionAppsPatchSet(int[] anVersion)
```
    This method will map Fusion Apps versions to the correct Coherence version.
    
    Parameters:
    
    anVersion - the possible FA version to resolve to a Coherence version
  - resolveFusionAppsPatchSet
```
public static int resolveFusionAppsPatchSet(int nMajor,
                                            int nMinor,
                                            int nMicro,
                                            int nPatchSet)
```
    Return the actual patch set value to use for a given version.
    This method will map Fusion Apps versions to the correct Coherence version.
    
    Parameters:
    
    nMajor - the major version number
    
    nMinor - the minor version number
    
    nMicro - the micro version number
    
    nPatchSet - the patch set version number
    
    Returns:
    
    the actual patch set value to use
  - main
```
public static void main(String[] args)
```
    Compare two version strings for compatability.
    The first string is the version to test, the second is the version required. If the second version is compatible with the first, then "pass" is displayed otherwise "fail" is displayed.
    
    Parameters:
    
    args - the two version strings to compare

Class VersionHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION_23_09

VERSION_23_09_1

VERSION_14_1_1_2206

VERSION_14_1_1_2206_6

VERSION_14_1_1_2206_7

VERSION_14_1_2_0

VERSION_14_1_1_0

VERSION_14_1_1_0_16

VERSION_14_1_1_0_17

VERSION_12_2_1_4

VERSION_12_2_1_4_20

VERSION_12_2_1_4_21

VERSION_12_2_1_6

VERSION_12_2_1_6_6

VERSION_12_2_1_6_7

Constructor Detail

VersionHelper

Method Detail

encodeVersion

encodeVersion

getVersionPrefix

isCalendarVersion

parseVersion

toVersionArray

toVersionString

isVersionCompatible

isPatchCompatible

resolveFusionAppsPatchSet

resolveFusionAppsPatchSet

main