org.graalvm.home

Class Version

java.lang.Object

org.graalvm.home.Version

All Implemented Interfaces:

Comparable<Version>

public final class Version
extends Object
implements Comparable<Version>

A version utility to canonicalize and compare GraalVM versions. The GraalVM version string is not standardized and may change without notice. This class is designed to evolve with GraalVM to cover all used version formats in use. It allows to create, validate and compare GraalVM versions. Do not rely on the format of the raw version string or the result of Version.toString(), only use it to produce output for humans.

To create version instances of a particular version use the Version.create(int...) factory method. Use Version.getCurrent() to lookup the current GraalVM version or Version.parse(String) to parse it from a raw string.

Usage example:

This code example compares the current GraalVM version to be at least 19.3 and fails if it is not.

 if (Version.getCurrent().compareTo(19, 3) < 0) {
     throw new IllegalStateException("Invalid GraalVM version. Must be at least 19.3.");
 }
 

Note: this class has a natural ordering that is inconsistent with equals.

Since:

19.3

See Also:

HomeFinder.getVersion()

Method Summary

Modifier and Type	Method and Description
int	compareTo(int... compareVersions) Compares this version to another GraalVM version.
int	compareTo(Version o)
static Version	create(int... versions) Constructs a new GraalVM version from a list of version numbers.
boolean	equals(Object obj)
String	format(String format) Format the GraalVM version with a custom format string.
static Version	getCurrent() Returns the current GraalVM version of the installed component.
int	hashCode()
boolean	isRelease() Returns true if this is a supported release build of GraalVM else false.
boolean	isSnapshot() Returns true if this is an unsupported snapshot build of GraalVM else false.
static Version	parse(String versionString) Parses a GraalVM version from its String raw format.
String	toString()

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Method Detail

isRelease

public boolean isRelease()

Returns true if this is a supported release build of GraalVM else false. Use this for implementation assertions that verify that only releases are deployed to production.

Since:

19.3

See Also:

Version.isSnapshot()

isSnapshot

public boolean isSnapshot()

Returns true if this is an unsupported snapshot build of GraalVM else false. Use this for implementation assertions that verify that only releases are deployed to production.

Since:

19.3

See Also:

Version.isSnapshot()

compareTo

public int compareTo(Version o)

Specified by:

compareTo in interface Comparable<Version>

Since:

19.3

compareTo

public int compareTo(int... compareVersions)

Compares this version to another GraalVM version. This is equivalent to using: compareTo(Version.create(compareVersions)) .

Since:

19.3

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

19.3

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

19.3

toString

public String toString()

Overrides:

toString in class Object

Since:

19.3

format

public String format(String format)

Format the GraalVM version with a custom format string.

The format string can contain any of the standard conversions of Formatter. At least four version components (possibly zero) are available as formatter arguments.

In addition to the standard conversions, these special conversions are available:

• "%[R...]" includes a given part only if Version.isRelease()
• "%[S...]" includes a given part only if Version.isSnapshot()
• "%[<digit>...]" includes a given part only if the version contains at least <digit> non-zero version components (<digit> can be 0 to 9)

Examples:

 Version.parse("22.3.0.1").format("%d.%d"); // returns "22.3"
 Version.parse("22.3.0.1").format("%4$d"); // returns "1"
 Version.parse("22.3.0.1").format("%[R%d.%d]%[Sdev]"); // returns "22.3"
 Version.parse("22.3.0.1").format("%[2XX]"); // returns "XX"
 Version.parse("23.0-dev").format("%3$d"); // returns "0"
 Version.parse("23.0-dev").format("%[R%d.%d]%[Sdev]"); // returns "dev"
 Version.parse("23.0-dev").format("%[2XX]"); // returns ""
 

Since:

23.0

parse

public static Version parse(String versionString)
                     throws IllegalArgumentException

Parses a GraalVM version from its String raw format. Throws IllegalArgumentException if the passed string is not a valid GraalVM version.

Throws:

IllegalArgumentException

Since:

19.3

create

public static Version create(int... versions)
                      throws IllegalArgumentException

Constructs a new GraalVM version from a list of version numbers. The versions must not be null and none of the version numbers must be negative. At least one version number must be non-zero.

Throws:

IllegalArgumentException

Since:

19.3

See Also:

Version.compareTo(int...)

getCurrent

public static Version getCurrent()

Returns the current GraalVM version of the installed component. Never null.

Since:

19.3

See Also:

HomeFinder.getVersion()