org.graalvm.nativeimage.Platform Maven / Gradle / Ivy
Show all versions of graal-sdk Show documentation
/*
* Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.graalvm.nativeimage;
/**
* 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 {@link Platform}. A leaf
* platform, e.g., a supported architecture-OS-combination, is a class that implements all the
* groups that it belongs to. It is good practice to make leaf platform classes {@code final}, to
* prevent accidental subclassing.
*
* The annotation {@link 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.
*
* @since 1.0
*/
public interface Platform {
/*
* The standard architectures that we support.
*/
/**
* Supported architecture: x86 64-bit.
*
* @since 1.0
*/
interface AMD64 extends Platform {
}
/*
* The standard operating systems that we support.
*/
/**
* Supported operating system: Linux.
*
* @since 1.0
*/
interface LINUX extends Platform {
}
/**
* Supported operating system: Darwin (MacOS).
*
* @since 1.0
*/
interface DARWIN extends Platform {
}
/**
* Supported operating system: Windows.
*
* @since 1.0
*/
interface WINDOWS extends Platform {
}
/*
* Standard leaf platforms, i.e., OS-architecture combinations that we support.
*/
/**
* Supported leaf platform: Linux on x86 64-bit.
*
* @since 1.0
*/
final class LINUX_AMD64 implements LINUX, AMD64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 1.0
*/
public LINUX_AMD64() {
}
}
/**
* Supported leaf platform: Darwin (MacOS) on x86 64-bit.
*
* @since 1.0
*/
final class DARWIN_AMD64 implements DARWIN, AMD64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 1.0
*/
public DARWIN_AMD64() {
}
}
/**
* Supported leaf platform: Windows on x86 64-bit.
*
* @since 1.0
*/
final class WINDOWS_AMD64 implements WINDOWS, AMD64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 1.0
*/
public WINDOWS_AMD64() {
}
}
/**
* 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 1.0
*/
final class HOSTED_ONLY implements Platform {
private HOSTED_ONLY() {
}
}
/**
* 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 1.0
*/
static boolean includedIn(Class platformGroup) {
return platformGroup.isInstance(ImageSingletons.lookup(Platform.class));
}
}