Package oracle.kv

Class KVVersion

java.lang.Object
oracle.kv.KVVersion
All Implemented Interfaces:
Serializable, Comparable<KVVersion>
public class KVVersion extends Object implements Comparable<KVVersion>, Serializable
Oracle NoSQL DB version information. Versions consist of major, minor and patch numbers.

There is one KVVersion object per running JVM and it may be accessed using the static field CURRENT_VERSION.

See Also:

  • Field Details

    • CURRENT_VERSION

      public static final KVVersion CURRENT_VERSION
      The current software version.

    • PREREQUISITE_VERSION

      public static final KVVersion PREREQUISITE_VERSION
      The current prerequisite version. Nodes can only join the cluster if they are running at least this version of the software. See note in SerialVersion.java about how to manage prerequisite version, compatibility, and dead code that occurs when the prerequisite moves.

  • Constructor Details

    • KVVersion

      public KVVersion(int majorNum, int minorNum, int patchNum, String name)

    • KVVersion

      public KVVersion(int oracleMajor, int oracleMinor, int majorNum, int minorNum, int patchNum, String name)

  • Method Details

    • main

      public static void main(String[] argv)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getOracleMajor

      public int getOracleMajor()
      Oracle Major number of the release version.
      Returns:
      The Oracle major number of the release version.

    • getOracleMinor

      public int getOracleMinor()
      Oracle Minor number of the release version.
      Returns:
      The Oracle minor number of the release version.

    • getMajor

      public int getMajor()
      Major number of the release version.
      Returns:
      The major number of the release version.

    • getMinor

      public int getMinor()
      Minor number of the release version.
      Returns:
      The minor number of the release version.

    • getPatch

      public int getPatch()
      Patch number of the release version.
      Returns:
      The patch number of the release version.

    • getReleaseId

      public String getReleaseId()
      Returns the internal release ID for the release version, or null if not known.
      Returns:
      the release ID or null

    • getReleaseDate

      public String getReleaseDate()
      Returns the release date for the release version, or null if not known.
      Returns:
      the release date or null

    • getReleaseEdition

      public String getReleaseEdition()
      Returns the name of the edition of the release version, or null if not known.
      Returns:
      the release edition or null

    • getNumericVersionString

      public String getNumericVersionString()
      The numeric version string without the release properties.
      Returns:
      The release version

    • getNumericVersionString

      public String getNumericVersionString(boolean withPatch)
      The numeric version string without the release properties, with or without the patch number.
      Returns:
      The release version

    • getVersionString

      public String getVersionString()
      Release version, suitable for display.
      Returns:
      The release version, suitable for display.

    • parseVersion

      public static KVVersion parseVersion(String versionString)
      Returns a KVVersion object representing the specified version string without the release ID, release date,and name parts filled in. This method is basically the inverse of getNumericVersionString(). This method will also parse a full version string (returned from toString()) but only the numeric version portion of the string.
      Parameters:
      versionString - version string to parse
      Returns:
      a KVVersion object

    • setReleaseId

      public void setReleaseId(String releaseId)

    • compareTo

      public int compareTo(KVVersion comparedVersion)
      Specified by:
      compareTo in interface Comparable<KVVersion>

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • assertVersionCheckDeprecation

      public static void assertVersionCheckDeprecation(KVVersion checkedVersion, String incompatibilityNote, String howToDeprecate)
      Asserts that a version check should be removed when certain version falls outside of the prerequisite range.
      Parameters:
      checkedVersion - the version compared to PREREQUISITE_VERSION which triggers an AssertionError if the comparison result is less than zero.
      incompatibilityNote - which documents the incompatibility problem for adding the check including the cause of the incompatibility and why the check can be removed
      howToDeprecate - which documents how to remove the deprecated version check
      See Also:
      • for more detail