Version (GraalVM SDK Java API Reference)

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

All Methods Static Methods Instance Methods Concrete Methods
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)`
`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, finalize, 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
  - 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()

Class Version

Usage example:

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isRelease

isSnapshot

compareTo

compareTo

equals

hashCode

toString

parse

create

getCurrent