Package io.github.jwharm.javagi.interop

Enum Class Platform

java.lang.Object

java.lang.Enum<Platform>

io.github.jwharm.javagi.interop.Platform

All Implemented Interfaces:

Serializable, Comparable<Platform>, Constable

public enum Platform
extends Enum<Platform>

The Platform class provides utility functions to retrieve the runtime platform and and check if a function is supported on the runtime platform.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LINUX
MACOS
WINDOWS

Method Summary

Modifier and Type	Method	Description
static void	checkSupportedPlatform(Platform... supportedPlatforms)	Check if the runtime platform is in the list of provided platforms; if not, throws UnsupportedPlatformException.
static Platform	getRuntimePlatform()	Determine the runtime platform
static Platform	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Platform[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

WINDOWS

public static final Platform WINDOWS

LINUX

public static final Platform LINUX

MACOS

public static final Platform MACOS

Method Details

values

public static Platform[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Platform valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getRuntimePlatform

public static Platform getRuntimePlatform()

Determine the runtime platform

Returns:

the runtime platform: "windows", "linux" or "macos"

checkSupportedPlatform

public static void checkSupportedPlatform(Platform... supportedPlatforms)
                                   throws UnsupportedPlatformException

Check if the runtime platform is in the list of provided platforms; if not, throws UnsupportedPlatformException.

Parameters:

supportedPlatforms - the platforms on which the api call is supported

Throws:

UnsupportedPlatformException - when the runtime platform does not support this api call