xref: /openjdk10/langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/platform/PlatformProvider.java

/*
 * Copyright (c) 2014, 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 com.sun.tools.javac.platform;

/** A collection of platform descriptions that can be selected using {@code --release name}
 *  command line option.
 *  Register in {@code META-INF/services/com.sun.tools.javac.platform.PlatformProvider}.
 *
 *  <p><b>This is NOT part of any supported API.
 *  If you write code that depends on this, you do so at your own risk.
 *  This code and its internal interfaces are subject to change or
 *  deletion without notice.</b>
 */
public interface PlatformProvider {

    /**Names of platforms supported by this provider. Each returned name can be used as the key for --release.
     *
     * @return the platform keys
     */
    Iterable<String> getSupportedPlatformNames();

    /**Create a description of a selected platform.
     *
     * @param platformName the name of the selected platform
     * @param options additional parameter, which can be specified after ':' on the command line
     * @return a PlatformDescription
     * @throws PlatformNotSupported if the given platform is not supported
     */
    PlatformDescription getPlatform(String platformName, String options) throws PlatformNotSupported;

    /**Throw if the given platform is not supported.
     */
    public class PlatformNotSupported extends Exception {
        private static final long serialVersionUID = 1L;
    }

}