Package com.hexaly.optimizer

Class HxVersion

java.lang.Object
com.hexaly.optimizer.HxVersion
public class HxVersion extends Object
Version, license and copyright info.

  • Constructor Details

    • HxVersion

      public HxVersion()

  • Method Details

    • getMajorVersionNumber

      public static final int getMajorVersionNumber()
      Returns Hexaly Optimizer major version number. This number is an integer in the range [0, 2999].
      Returns:
      Major version number.

    • getMinorVersionNumber

      public static final int getMinorVersionNumber()
      Returns Hexaly Optimizer minor version number. This number is an integer in the range [0, 9].
      Returns:
      Minor version number.

    • getBuildDate

      public static final int getBuildDate()
      Returns Hexaly Optimizer build date. This number is an integer YYYYMMDD with YYYY the year, MM the month, DD the day.
      Returns:
      Build date.

    • getPlatform

      public static final String getPlatform()
      Returns the platform of the Hexaly Optimizer binary as a string. The format of the string is PPPPXX where PPPP is the platform (Win, Linux or MacOS) and XX is the architecture (32 or 64 bits).
      Returns:
      Platform as string.
      Since:
      3.0

    • getVersion

      public static final String getVersion()
      Returns Hexaly Optimizer version as a string. The format of the string is: MA.MI.YYYYMMDD-PPPPXX with MA the major number version, MI the minor number version, YYYY the year, MM the month, DD the day, PPPP the platform (Win, Linux or MacOS) and XX the architecture.
      Returns:
      Version as string "MA.MI.YYYYMMDD-PPPPXX".

    • getVersionCode

      public static final int getVersionCode()
      Returns Hexaly Optimizer version code as an integer in the range [0, 29999]. The version code is computed as follows: MA * 10 + MI with MA the major number version, MI the minor number version. Note that the version code can be encoded as a 16-bit integer.
      Returns:
      Version code.

    • getCopyright

      public static final String getCopyright()
      Returns Hexaly Optimizer copyright as a string.
      Returns:
      Copyright notice.

    • getInfo

      public static final String getInfo()
      Returns version and copyright info as a string.
      Returns:
      Version and copyright info.

    • getLicensePath

      public static final String getLicensePath()
      Returns the license path of Hexaly Optimizer. By default, Hexaly Optimizer looks for a license file in the following locations, in that order:
      1. A file specified by a call to setLicensePath(java.lang.String).
      2. The HX_LICENSE_PATH environment variable.
      3. The deprecated LS_LICENSE_PATH environment variable.
      4. A license.dat file in the current directory.
      5. In the default global location (c:\hexaly\license.dat on Windows, /opt/hexaly/license.dat on Linux and macOS).
      6. In the deprecated LocalSolver global location (c:\localsolver\license.dat on Windows, /opt/localsolver/license.dat on Linux and macOS).

      For windows users: If you used the installer to setup Hexaly, the HX_LICENSE_PATH environment variable is already defined and points to the license file present in the installation folder.

      Note: The license content can also be set directly with setLicenseContent(java.lang.String) or with the HX_LICENSE_CONTENT environment variable and this definition will have priority over the license file. The old environment variable LS_LICENSE_CONTENT can also be used, but its usage is deprecated.

      Returns:
      Path to the license
      Since:
      3.0
      See Also:

    • setLicensePath

      public static final void setLicensePath(String licensePath)
      Changes the license path used by Hexaly Optimizer.
      Parameters:
      licensePath - new path for the license
      Since:
      3.0
      See Also:

    • getLicenseContent

      public static final String getLicenseContent()
      Returns the license content previously set with setLicenseContent(java.lang.String) or the HX_LICENSE_CONTENT environment variable.
      Returns:
      The content of the license or an empty string if the content was not set.
      Since:
      5.0
      See Also:

    • setLicenseContent

      public static final void setLicenseContent(String licenseContent)
      Changes the license content. By default, Hexaly tries to get the license content from the HX_LICENSE_CONTENT environment variable or from the file specified in setLicensePath or in a default location. Use this function to set the license content directly, without using a file.
      Parameters:
      licenseContent - content of the license to use.
      Since:
      5.0
      See Also: