Package io.github.jwharm.javagi.interop

Class Platform

java.lang.Object

io.github.jwharm.javagi.interop.Platform

public class Platform
extends Object

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

Constructor Summary

Constructors

Constructor	Description
Platform()

Method Summary

Modifier and Type	Method	Description
static void	checkSupportedPlatform(String... supportedPlatforms)	Check if the runtime platform is in the list of provided platforms; if not, throws UnsupportedPlatformException.
static String	getRuntimePlatform()	Determine the runtime platform

Methods inherited from class java.lang.Object

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

Constructor Details

Platform

public Platform()

Method Details

getRuntimePlatform

public static String getRuntimePlatform()

Determine the runtime platform

Returns:

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

checkSupportedPlatform

public static void checkSupportedPlatform(String... 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