net.kano.joscar
Class JoscarTools

java.lang.Object
  extended bynet.kano.joscar.JoscarTools

public final class JoscarTools
extends java.lang.Object

Provides a set of methods and fields designed for retrieving information about the joscar library itself.


Field Summary
static int JOSCAR_VERSION_MAJOR
          The "major" version of joscar being used.
static int JOSCAR_VERSION_MINOR
          The "minor" version of joscar being used.
static int JOSCAR_VERSION_PATCH
          The "patch" version of joscar being used.
 
Method Summary
static java.lang.String getVersionString()
          Returns a version string describing the version of joscar loaded.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

JOSCAR_VERSION_MAJOR

public static final int JOSCAR_VERSION_MAJOR
The "major" version of joscar being used. This will return the 1 in version 1.2.3.

See Also:
Constant Field Values

JOSCAR_VERSION_MINOR

public static final int JOSCAR_VERSION_MINOR
The "minor" version of joscar being used. This will return the 2 in version 1.2.3.

See Also:
Constant Field Values

JOSCAR_VERSION_PATCH

public static final int JOSCAR_VERSION_PATCH
The "patch" version of joscar being used. This will return the 3 in version 1.2.3.

See Also:
Constant Field Values
Method Detail

getVersionString

public static java.lang.String getVersionString()
Returns a version string describing the version of joscar loaded. This will be a string like "0.9" or "2.4.6".

Returns:
a version string describing the version of joscar loaded
See Also:
JOSCAR_VERSION_MAJOR, JOSCAR_VERSION_MINOR, JOSCAR_VERSION_PATCH