Package VASSAL

Class Info

java.lang.Object

VASSAL.Info

public final class Info
extends Object

Class for storing release-related information

Field Summary

Fields

Modifier and Type	Field	Description
static String	javaBinPath	The path to the JVM binary.

Method Summary

Modifier and Type	Method	Description
static int	compareVersions(String v0, String v1)	Deprecated. use VersionUtils.compareVersions(String, String)
static File	getBaseDir()	Returns the directory where VASSAL is installed.
static File	getBinDir()
static File	getConfDir()
static File	getDocDir()
static File	getHomeDir()
static int	getInstanceID()	Returns the instance id for this process.
static File	getPrefsDir()
static Rectangle	getScreenBounds(Component c)
static File	getTempDir()
static String	getVersion()	A valid version format is "w.x.[y|bz]", where 'w','x','y', and 'z' are integers.
static boolean	hasOldFormat(String version)
static boolean	is2dEnabled()	Deprecated. since Java 1.4 is now required
static boolean	isDndEnabled()	Deprecated. Check is no longer necessary since Java 1.4+ is required.
static boolean	isMacOSX()	Deprecated. Use SystemUtils.IS_OS_MAC_OSX instead
static boolean	isModuleTooNew(String version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

javaBinPath

public static final String javaBinPath

The path to the JVM binary.

Method Details

getVersion

public static String getVersion()

A valid version format is "w.x.[y|bz]", where 'w','x','y', and 'z' are integers. In the version number, w.x are the major/minor release number, y is the bug-fix release number, and the 'b' indicates a beta release, e.g. 3.0b2.

Returns:

the version of the VASSAL engine.

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.

getScreenBounds

public static Rectangle getScreenBounds(Component c)

Returns:

size of screen accounting for the screen insets (i.e. Windows taskbar)

isMacOSX

@Deprecated public static boolean isMacOSX()

Deprecated.

Use SystemUtils.IS_OS_MAC_OSX instead

isModuleTooNew

public static boolean isModuleTooNew(String version)

hasOldFormat

public static boolean hasOldFormat(String version)

compareVersions

@Deprecated public static int compareVersions(String v0, String v1)

Deprecated.

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 parseable parts of the two Strings.

getBaseDir

public static File getBaseDir()

Returns the directory where VASSAL is installed.

Returns:

a File representing the directory

getBinDir

public static File getBinDir()

getDocDir

public static File getDocDir()

getConfDir

public static File getConfDir()

getTempDir

public static File getTempDir()

getPrefsDir

public static File getPrefsDir()

getHomeDir

public static File getHomeDir()

isDndEnabled

@Deprecated public static boolean isDndEnabled()

Deprecated.

Check is no longer necessary since Java 1.4+ is required.

Returns:

true if this platform supports Swing Drag and Drop

is2dEnabled

@Deprecated public static boolean is2dEnabled()

Deprecated.

since Java 1.4 is now required

Returns:

true if this platform supports Java2D