Root of the interface hierarchy for architectures, OS, and supported combinations of them.

A platform group (e.g., an architecture or OS) is an interface extending Platform. A leaf platform, e.g., a supported architecture-OS-combination, is a class that implements all the groups that it belongs to. A leaf platform class must be non-abstract and must have a no-argument constructor. It is good practice to make leaf platform classes final (to prevent accidental subclassing) and to avoid state (i.e., no fields).

The annotation Platforms restricts a type, method, or field to certain platform groups or leaf platforms.

This system makes the set of platform groups and leaf platforms extensible. Some standard platforms are defined as inner classes.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	Platform.AARCH64 Supported architecture: ARMv8 64-bit.
public static interface	Platform.AMD64 Supported architecture: x86 64-bit.
public static interface	Platform.ANDROID Supported operating system: Android.
public static class	Platform.ANDROID_AARCH64 Supported leaf platform: Android on AArch64 64-bit.
public static interface	Platform.DARWIN Basis for all Apple operating systems (MacOS and iOS).
public static interface	Platform.DARWIN_AARCH64 Basis for all Apple operating systems on AMD64 (MACOS_AMD64 & IOS_AMD64).
public static interface	Platform.DARWIN_AMD64 Basis for all Apple operating systems on AMD64 (MACOS_AMD64 & IOS_AMD64).
public static class	Platform.HOSTED_ONLY Marker for elements (types, methods, or fields) that are only visible during native image generation and cannot be used at run time, regardless of the actual platform.
public static interface	Platform.IOS Supported operating system: iOS.
public static class	Platform.IOS_AARCH64 Supported leaf platform: iOS on AArch 64-bit.
public static class	Platform.IOS_AMD64 Supported leaf platform: iOS on x86 64-bit.
public static interface	Platform.LINUX Supported operating system: Linux.
public static class	Platform.LINUX_AARCH64 Supported leaf platform: Linux on AArch64 64-bit.
public static interface	Platform.LINUX_AARCH64_BASE Basis for all Linux operating systems on AARCH64 (LINUX_AARCH64 & ANDROID_AARCH64).
public static class	Platform.LINUX_AMD64 Supported leaf platform: Linux on x86 64-bit.
public static interface	Platform.LINUX_AMD64_BASE Basis for all Linux operating systems on AMD64 (LINUX_AMD64).
public static class	Platform.LINUX_RISCV64 Supported leaf platform: Linux on RISC-V 64-bit.
public static interface	Platform.MACOS Supported operating system: MacOS.
public static class	Platform.MACOS_AARCH64 Supported leaf platform: MacOS on AArch 64-bit.
public static class	Platform.MACOS_AMD64 Supported leaf platform: MacOS on x86 64-bit.
public static interface	Platform.RISCV64 Supported architecture: RISC-V 64-bit.
public static interface	Platform.WINDOWS Supported operating system: Windows.
public static class	Platform.WINDOWS_AARCH64 Supported leaf platform: Windows on AArch 64-bit.
public static class	Platform.WINDOWS_AMD64 Supported leaf platform: Windows on x86 64-bit.

Field Summary

Modifier and Type	Field and Description
public static final String	PLATFORM_PROPERTY_NAME The system property name that specifies the fully qualified name of the `Platform` implementation class that should be used.

Method Summary

Modifier and Type	Method and Description
public default String	getArchitecture() Returns the string representing Platform's architecture name.
public default String	getOS() Returns the string representing Platform's OS name.
public static boolean	includedIn(Class<? extends Platform> platformGroup) Returns true if the current platform (the platform that the native image is built for) is included in the provided platform group.

Field Detail

PLATFORM_PROPERTY_NAME back to summary

PLATFORM_PROPERTY_NAME	back to summary
public static final String PLATFORM_PROPERTY_NAME The system property name that specifies the fully qualified name of the `Platform` implementation class that should be used. If the property is not specified, the platform class is inferred from the standard architectures and operating systems specified in this file, i.e., in most cases it is not necessary to use this property. Since 19.0

public static final String PLATFORM_PROPERTY_NAME

The system property name that specifies the fully qualified name of the Platform implementation class that should be used. If the property is not specified, the platform class is inferred from the standard architectures and operating systems specified in this file, i.e., in most cases it is not necessary to use this property.

Since: 19.0

Method Detail

getArchitecture	back to summary
public default String getArchitecture() Returns the string representing Platform's architecture name. This value should be the same as desired os.arch system property. This method should be implemented either in final class or as default method in respective architecture interface. Since 21.0

getArchitecture

back to summary

public default String getArchitecture()

Returns the string representing Platform's architecture name. This value should be the same as desired os.arch system property.

This method should be implemented either in final class or as default method in respective architecture interface.

Since: 21.0

getOS	back to summary
public default String getOS() Returns the string representing Platform's OS name. This method should be implemented either in a final class or as default method in respective OS interface. Since 21.0

getOS

back to summary

public default String getOS()

Returns the string representing Platform's OS name.

This method should be implemented either in a final class or as default method in respective OS interface.

Since: 21.0

includedIn	back to summary
public static boolean includedIn(Class<? extends Platform> platformGroup) Returns true if the current platform (the platform that the native image is built for) is included in the provided platform group. The platformGroup must be a compile-time constant, so that the call to this method can be replaced with the constant boolean result. Since 19.0

includedIn

back to summary

public static boolean includedIn(Class<? extends Platform> platformGroup)

Returns true if the current platform (the platform that the native image is built for) is included in the provided platform group.

The platformGroup must be a compile-time constant, so that the call to this method can be replaced with the constant boolean result.

Since: 19.0

org.graalvm.nativeimage back to summary

public Interface Platform.AARCH64

Known Direct Subinterfaces: org.graalvm.nativeimage.Platform.LINUX_AARCH64_BASE, org.graalvm.nativeimage.Platform.DARWIN_AARCH64
Known Direct Implementers: org.graalvm.nativeimage.Platform.WINDOWS_AARCH64

Supported architecture: ARMv8 64-bit.

Since: 19.0

Field Summary

Inherited from org.graalvm.nativeimage.Platform:: PLATFORM_PROPERTY_NAME

Method Summary

Modifier and Type	Method and Description
public default String	getArchitecture() Overrides default org.graalvm.nativeimage.Platform.getArchitecture. Returns string representing AARCH64 architecture.

Inherited from org.graalvm.nativeimage.Platform:: getOS includedIn

Method Detail

getArchitecture	back to summary
public default String getArchitecture() Overrides default org.graalvm.nativeimage.Platform.getArchitecture. Returns string representing AARCH64 architecture. Since 21.0

getArchitecture

back to summary

public default String getArchitecture()

Overrides default org.graalvm.nativeimage.Platform.getArchitecture.

Returns string representing AARCH64 architecture.

Since: 21.0

org.graalvm.nativeimage back to summary

public Interface Platform.AMD64

Known Direct Subinterfaces: org.graalvm.nativeimage.Platform.LINUX_AMD64_BASE, org.graalvm.nativeimage.Platform.DARWIN_AMD64
Known Direct Implementers: org.graalvm.nativeimage.Platform.WINDOWS_AMD64

Supported architecture: x86 64-bit.

Since: 19.0

Field Summary

Inherited from org.graalvm.nativeimage.Platform:: PLATFORM_PROPERTY_NAME

Method Summary

Modifier and Type	Method and Description
public default String	getArchitecture() Overrides default org.graalvm.nativeimage.Platform.getArchitecture. Returns string representing AMD64 architecture.

Inherited from org.graalvm.nativeimage.Platform:: getOS includedIn

Method Detail

getArchitecture	back to summary
public default String getArchitecture() Overrides default org.graalvm.nativeimage.Platform.getArchitecture. Returns string representing AMD64 architecture. Since 21.0

getArchitecture

back to summary

public default String getArchitecture()

Overrides default org.graalvm.nativeimage.Platform.getArchitecture.

Returns string representing AMD64 architecture.

Since: 21.0

org.graalvm.nativeimage back to summary

public Interface Platform.ANDROID

Known Direct Implementers: org.graalvm.nativeimage.Platform.ANDROID_AARCH64

Supported operating system: Android.

Since: 21.0

Method Summary

Modifier and Type	Method and Description
public default String	getOS() Overrides default org.graalvm.nativeimage.Platform.LINUX.getOS. Returns string representing ANDROID OS.

Method Detail

getOS	back to summary
public default String getOS() Overrides default org.graalvm.nativeimage.Platform.LINUX.getOS. Returns string representing ANDROID OS. Since 21.0

getOS

back to summary

public default String getOS()

Overrides default org.graalvm.nativeimage.Platform.LINUX.getOS.

Returns string representing ANDROID OS.

Since: 21.0

org.graalvm.nativeimage back to summary

public final Class Platform.ANDROID_AARCH64

Class Inheritance

extends Object
implements ANDROID, LINUX_AARCH64_BASE

java.lang.Object
org.graalvm.nativeimage.Platform.ANDROID_AARCH64

All Implemented Interfaces

org.graalvm.nativeimage.Platform.LINUX_AARCH64_BASE, org.graalvm.nativeimage.Platform.AARCH64, org.graalvm.nativeimage.impl.InternalPlatform.NATIVE_ONLY, org.graalvm.nativeimage.Platform, org.graalvm.nativeimage.Platform.LINUX, org.graalvm.nativeimage.impl.InternalPlatform.PLATFORM_JNI, org.graalvm.nativeimage.Platform.ANDROID

Supported leaf platform: Android on AArch64 64-bit.

Since: 21.0

Constructor Summary

Access	Constructor and Description
public	ANDROID_AARCH64() Instantiates a marker instance of this platform.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ANDROID_AARCH64	back to summary
public ANDROID_AARCH64() Instantiates a marker instance of this platform. Since 21.0

ANDROID_AARCH64

back to summary

public ANDROID_AARCH64()

Instantiates a marker instance of this platform.

Since: 21.0

org.graalvm.nativeimage back to summary

public Interface Platform.DARWIN

Known Direct Subinterfaces: org.graalvm.nativeimage.Platform.IOS, org.graalvm.nativeimage.Platform.MACOS, org.graalvm.nativeimage.Platform.DARWIN_AMD64, org.graalvm.nativeimage.Platform.DARWIN_AARCH64

Basis for all Apple operating systems (MacOS and iOS).

Since: 19.0

org.graalvm.nativeimage back to summary

public Interface Platform.DARWIN_AARCH64

Known Direct Implementers: org.graalvm.nativeimage.Platform.IOS_AARCH64, org.graalvm.nativeimage.Platform.MACOS_AARCH64

Basis for all Apple operating systems on AMD64 (MACOS_AMD64 & IOS_AMD64).

Since: 22.1

Method Summary

Inherited from org.graalvm.nativeimage.Platform.AARCH64:: getArchitecture

org.graalvm.nativeimage back to summary

public Interface Platform.DARWIN_AMD64

Known Direct Implementers: org.graalvm.nativeimage.Platform.IOS_AMD64, org.graalvm.nativeimage.Platform.MACOS_AMD64

Basis for all Apple operating systems on AMD64 (MACOS_AMD64 & IOS_AMD64).

Since: 22.1

Method Summary

Inherited from org.graalvm.nativeimage.Platform.AMD64:: getArchitecture

org.graalvm.nativeimage back to summary

public final Class Platform.HOSTED_ONLY

Class Inheritance

extends Object
implements Platform

java.lang.Object
org.graalvm.nativeimage.Platform.HOSTED_ONLY

All Implemented Interfaces

org.graalvm.nativeimage.Platform

Marker for elements (types, methods, or fields) that are only visible during native image generation and cannot be used at run time, regardless of the actual platform.

Since: 19.0

Constructor Summary

Access	Constructor and Description
private	HOSTED_ONLY()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

HOSTED_ONLY	back to summary
private HOSTED_ONLY()

org.graalvm.nativeimage back to summary

public Interface Platform.IOS

Known Direct Implementers: org.graalvm.nativeimage.Platform.IOS_AMD64, org.graalvm.nativeimage.Platform.IOS_AARCH64

Supported operating system: iOS.

Since: 21.0

Method Summary

Modifier and Type	Method and Description
public default String	getOS() Overrides default org.graalvm.nativeimage.Platform.getOS. Returns string representing iOS OS.

Method Detail

getOS	back to summary
public default String getOS() Overrides default org.graalvm.nativeimage.Platform.getOS. Returns string representing iOS OS. Since 21.0

getOS

back to summary

public default String getOS()

Overrides default org.graalvm.nativeimage.Platform.getOS.

Returns string representing iOS OS.

Since: 21.0

org.graalvm.nativeimage back to summary

public final Class Platform.IOS_AARCH64

Class Inheritance

extends Object
implements IOS, DARWIN_AARCH64

java.lang.Object
org.graalvm.nativeimage.Platform.IOS_AARCH64

All Implemented Interfaces

org.graalvm.nativeimage.Platform.DARWIN_AARCH64, org.graalvm.nativeimage.Platform.AARCH64, org.graalvm.nativeimage.impl.InternalPlatform.NATIVE_ONLY, org.graalvm.nativeimage.Platform, org.graalvm.nativeimage.Platform.DARWIN, org.graalvm.nativeimage.impl.InternalPlatform.PLATFORM_JNI, org.graalvm.nativeimage.Platform.IOS

Supported leaf platform: iOS on AArch 64-bit.

Since: 21.0

Constructor Summary

Access	Constructor and Description
public	IOS_AARCH64() Instantiates a marker instance of this platform.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

IOS_AARCH64	back to summary
public IOS_AARCH64() Instantiates a marker instance of this platform. Since 21.0

IOS_AARCH64

back to summary

public IOS_AARCH64()

Instantiates a marker instance of this platform.

Since: 21.0

org.graalvm.nativeimage back to summary

public final Class Platform.IOS_AMD64

Class Inheritance

extends Object
implements IOS, DARWIN_AMD64

java.lang.Object
org.graalvm.nativeimage.Platform.IOS_AMD64

All Implemented Interfaces

org.graalvm.nativeimage.Platform.DARWIN_AMD64, org.graalvm.nativeimage.Platform.AMD64, org.graalvm.nativeimage.impl.InternalPlatform.NATIVE_ONLY, org.graalvm.nativeimage.Platform, org.graalvm.nativeimage.Platform.DARWIN, org.graalvm.nativeimage.impl.InternalPlatform.PLATFORM_JNI, org.graalvm.nativeimage.Platform.IOS

Supported leaf platform: iOS on x86 64-bit.

Since: 21.3

Constructor Summary

Access	Constructor and Description
public	IOS_AMD64() Instantiates a marker instance of this platform.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

IOS_AMD64	back to summary
public IOS_AMD64() Instantiates a marker instance of this platform. Since 21.3

IOS_AMD64

back to summary

public IOS_AMD64()

Instantiates a marker instance of this platform.

Since: 21.3

org.graalvm.nativeimage back to summary

public Interface Platform.LINUX

Known Direct Subinterfaces: org.graalvm.nativeimage.Platform.ANDROID, org.graalvm.nativeimage.Platform.LINUX_AMD64_BASE, org.graalvm.nativeimage.Platform.LINUX_AARCH64_BASE
Known Direct Implementers: org.graalvm.nativeimage.Platform.LINUX_AMD64, org.graalvm.nativeimage.Platform.LINUX_AARCH64, org.graalvm.nativeimage.Platform.LINUX_RISCV64

Supported operating system: Linux.

Since: 19.0

Method Summary

Modifier and Type	Method and Description
public default String	getOS() Overrides default org.graalvm.nativeimage.Platform.getOS. Returns string representing LINUX OS.

Method Detail

getOS	back to summary
public default String getOS() Overrides default org.graalvm.nativeimage.Platform.getOS. Returns string representing LINUX OS. Since 21.0

getOS

back to summary

public default String getOS()

Overrides default org.graalvm.nativeimage.Platform.getOS.

Returns string representing LINUX OS.

Since: 21.0

org.graalvm.nativeimage back to summary

public final Class Platform.LINUX_AARCH64

Class Inheritance

extends Object
implements LINUX, LINUX_AARCH64_BASE

java.lang.Object
org.graalvm.nativeimage.Platform.LINUX_AARCH64

All Implemented Interfaces

Supported leaf platform: Linux on AArch64 64-bit.

Since: 19.0

Constructor Summary

Access	Constructor and Description
public	LINUX_AARCH64() Instantiates a marker instance of this platform.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

LINUX_AARCH64	back to summary
public LINUX_AARCH64() Instantiates a marker instance of this platform. Since 19.0

LINUX_AARCH64

back to summary

public LINUX_AARCH64()

Instantiates a marker instance of this platform.

Since: 19.0

org.graalvm.nativeimage back to summary

public Interface Platform.LINUX_AARCH64_BASE

Known Direct Implementers: org.graalvm.nativeimage.Platform.LINUX_AARCH64, org.graalvm.nativeimage.Platform.ANDROID_AARCH64

Basis for all Linux operating systems on AARCH64 (LINUX_AARCH64 & ANDROID_AARCH64).

Since: 22.1

Method Summary

Inherited from org.graalvm.nativeimage.Platform.AARCH64:: getArchitecture
Inherited from org.graalvm.nativeimage.Platform.LINUX:: getOS

org.graalvm.nativeimage back to summary

public Class Platform.LINUX_AMD64

Class Inheritance

extends Object
implements LINUX, LINUX_AMD64_BASE

java.lang.Object
org.graalvm.nativeimage.Platform.LINUX_AMD64

All Implemented Interfaces

org.graalvm.nativeimage.Platform.LINUX_AMD64_BASE, org.graalvm.nativeimage.Platform.AMD64, org.graalvm.nativeimage.impl.InternalPlatform.NATIVE_ONLY, org.graalvm.nativeimage.Platform, org.graalvm.nativeimage.Platform.LINUX, org.graalvm.nativeimage.impl.InternalPlatform.PLATFORM_JNI

Supported leaf platform: Linux on x86 64-bit.

Since: 19.0

Constructor Summary

Access	Constructor and Description
public	LINUX_AMD64() Instantiates a marker instance of this platform.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

LINUX_AMD64	back to summary
public LINUX_AMD64() Instantiates a marker instance of this platform. Since 19.0

LINUX_AMD64

back to summary

public LINUX_AMD64()

Instantiates a marker instance of this platform.

Since: 19.0

org.graalvm.nativeimage back to summary

public Interface Platform.LINUX_AMD64_BASE

Known Direct Implementers: org.graalvm.nativeimage.Platform.LINUX_AMD64

Basis for all Linux operating systems on AMD64 (LINUX_AMD64).

Since: 22.1

Method Summary

Inherited from org.graalvm.nativeimage.Platform.AMD64:: getArchitecture
Inherited from org.graalvm.nativeimage.Platform.LINUX:: getOS

org.graalvm.nativeimage back to summary

public final Class Platform.LINUX_RISCV64

Class Inheritance

extends Object
implements LINUX, RISCV64

java.lang.Object
org.graalvm.nativeimage.Platform.LINUX_RISCV64

All Implemented Interfaces

org.graalvm.nativeimage.Platform.RISCV64, org.graalvm.nativeimage.Platform, org.graalvm.nativeimage.Platform.LINUX, org.graalvm.nativeimage.impl.InternalPlatform.NATIVE_ONLY, org.graalvm.nativeimage.impl.InternalPlatform.PLATFORM_JNI

Supported leaf platform: Linux on RISC-V 64-bit.

Since: 22.2

Constructor Summary

Access	Constructor and Description
public	LINUX_RISCV64() Instantiates a marker instance of this platform.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

LINUX_RISCV64	back to summary
public LINUX_RISCV64() Instantiates a marker instance of this platform. Since 22.2

LINUX_RISCV64

back to summary

public LINUX_RISCV64()

Instantiates a marker instance of this platform.

Since: 22.2

org.graalvm.nativeimage back to summary

public Interface Platform.MACOS

Known Direct Implementers: org.graalvm.nativeimage.Platform.MACOS_AMD64, org.graalvm.nativeimage.Platform.MACOS_AARCH64

Supported operating system: MacOS.

Since: 22.1

Method Summary

Modifier and Type	Method and Description
public default String	getOS() Overrides default org.graalvm.nativeimage.Platform.getOS. Returns string representing MACOS OS.

Method Detail

getOS	back to summary
public default String getOS() Overrides default org.graalvm.nativeimage.Platform.getOS. Returns string representing MACOS OS. Since 21.0

getOS

back to summary

public default String getOS()

Overrides default org.graalvm.nativeimage.Platform.getOS.

Returns string representing MACOS OS.

Since: 21.0

org.graalvm.nativeimage back to summary

public final Class Platform.MACOS_AARCH64

Class Inheritance

extends Object
implements MACOS, DARWIN_AARCH64

java.lang.Object
org.graalvm.nativeimage.Platform.MACOS_AARCH64

All Implemented Interfaces

Supported leaf platform: MacOS on AArch 64-bit.

Since: 22.1

Constructor Summary

Access	Constructor and Description
public	MACOS_AARCH64() Instantiates a marker instance of this platform.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

MACOS_AARCH64	back to summary
public MACOS_AARCH64() Instantiates a marker instance of this platform. Since 22.1

MACOS_AARCH64

back to summary

public MACOS_AARCH64()

Instantiates a marker instance of this platform.

Since: 22.1

org.graalvm.nativeimage back to summary

public final Class Platform.MACOS_AMD64

Class Inheritance

extends Object
implements MACOS, DARWIN_AMD64

java.lang.Object
org.graalvm.nativeimage.Platform.MACOS_AMD64

All Implemented Interfaces

Supported leaf platform: MacOS on x86 64-bit.

Since: 22.1

Constructor Summary

Access	Constructor and Description
public	MACOS_AMD64() Instantiates a marker instance of this platform.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

MACOS_AMD64	back to summary
public MACOS_AMD64() Instantiates a marker instance of this platform. Since 22.1

MACOS_AMD64

back to summary

public MACOS_AMD64()

Instantiates a marker instance of this platform.

Since: 22.1

org.graalvm.nativeimage back to summary

public Interface Platform.RISCV64

Known Direct Implementers: org.graalvm.nativeimage.Platform.LINUX_RISCV64

Supported architecture: RISC-V 64-bit.

Since: 22.2

Field Summary

Inherited from org.graalvm.nativeimage.Platform:: PLATFORM_PROPERTY_NAME

Method Summary

Modifier and Type	Method and Description
public default String	getArchitecture() Overrides default org.graalvm.nativeimage.Platform.getArchitecture. Returns string representing RISCV64 architecture.

Inherited from org.graalvm.nativeimage.Platform:: getOS includedIn

Method Detail

getArchitecture	back to summary
public default String getArchitecture() Overrides default org.graalvm.nativeimage.Platform.getArchitecture. Returns string representing RISCV64 architecture. Since 22.2

getArchitecture

back to summary

public default String getArchitecture()

Overrides default org.graalvm.nativeimage.Platform.getArchitecture.

Returns string representing RISCV64 architecture.