Package VASSAL

Class Info

java.lang.Object
VASSAL.Info
public final class Info
extends Object
Class for storing release-related information

  • Field Details

    • javaBinPath

      @Deprecated(since="2020-10-03", forRemoval=true) public static final String javaBinPath
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getJavaBinPath() instead.
      The path to the JVM binary.

  • Method Details

    • setConfig

      public static void setConfig​(Config c)

    • getVersion

      public static String getVersion()
      A valid version format is "w.x.y[-z]", where 'w','x', and 'y' are integers and z is a string. In the version number, w.x are the major/minor release number, y is the bug-fix release number, and the 'z' identifies an intermediate build: e.g., 3.3.3-alpha1 or 3.3.3-SNAPSHOT
      Returns:
      the full version of the VASSAL engine.

    • getMinorVersion

      @Deprecated(since="2020-08-06", forRemoval=true) public static String getMinorVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      If you need the minor version number, get it from a VersionTokenizer.
      Returns:
      The major/minor portion of the release version. If the version is a beta-release number, a 'beta' is appended. For example, the minor version of 3.0.2 is 3.0, and the minor version of 3.0b3 is 3.0beta.

    • getReportableVersion

      public static String getReportableVersion()
      Bugzilla (and other potential external reporting tools) require only the primary numeric portion of the version number: e.g., 3.3.3-SNAPSHOT return 3.3.3.
      Returns:
      The reportable version number

    • getErrorLogPath

      public static File getErrorLogPath()
      Returns:
      a version-specific errorLog path

    • getJavaBinPath

      public static File getJavaBinPath()

    • getInstanceID

      public static int getInstanceID()
      Returns the instance id for this process. The instance id will be be unique across the Module Manager and its children.

    • getBaseDir

      public static File getBaseDir()
      Returns the directory where VASSAL is installed.
      Returns:
      a File representing the directory

    • getDocDir

      public static File getDocDir()

    • getConfDir

      public static File getConfDir()

    • getTempDir

      public static File getTempDir()

    • getPrefsDir

      public static File getPrefsDir()

    • getScreenBounds

      @Deprecated(since="2020-10-03", forRemoval=true) public static Rectangle getScreenBounds​(Component c)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      size of screen accounting for the screen insets (e.g., Windows taskbar)

    • isMacOSX

      @Deprecated(since="2020-08-06", forRemoval=true) public static boolean isMacOSX()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use SystemUtils.IS_OS_MAC_OSX instead

    • isMacOsX

      @Deprecated(since="2020-08-06", forRemoval=true) public static boolean isMacOsX()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use SystemUtils.IS_OS_MAC_OSX instead.

    • isWindows

      @Deprecated(since="2020-08-06", forRemoval=true) public static boolean isWindows()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use SystemUtils.IS_OS_WINDOWS instead

    • isModuleTooNew

      public static boolean isModuleTooNew​(String version)

    • hasOldFormat

      public static boolean hasOldFormat​(String version)

    • compareVersions

      @Deprecated(since="2020-08-06", forRemoval=true) public static int compareVersions​(String v0, String v1)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use VersionUtils.compareVersions(String, String)
      Compares VASSAL version strings. This method is guaranteed to correctly compare the current version string with any other version string. It is not guaranteed to correctly compare two arbitrary version strings.
      Returns:
      negative if v0 < v1, positive if v0 > v1, and zero if v0 == v1 or if the ordering cannot be determined from the parsable parts of the two Strings.

    • getDocsDir

      @Deprecated(since="2020-08-06", forRemoval=true) public static File getDocsDir()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getDocDir() instead.
      Returns the directory where the VASSAL documentation is installed.
      Returns:
      a File representing the directory

    • getBinDir

      @Deprecated(since="2020-10-03", forRemoval=true) public static File getBinDir()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getBaseDir() instead.

    • getHomeDir

      @Deprecated(since="2020-10-02", forRemoval=true) public static File getHomeDir()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getConfDir() instead.

    • isDndEnabled

      @Deprecated(since="2020-08-06", forRemoval=true) public static boolean isDndEnabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check is no longer necessary since Java 1.4+ is required.
      Returns:
      true if this platform supports Swing Drag and Drop

    • is2dEnabled

      @Deprecated(since="2020-08-06", forRemoval=true) public static boolean is2dEnabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since Java 1.4 is now required
      Returns:
      true if this platform supports Java2D