PlatformProvider.java revision 2973:0e8fa3249327 
1/*
2 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package com.sun.tools.javac.platform;
26
27/** A collection of platform descriptions that can be selected using {@code -release name}
28 *  command line option.
29 *  Register in {@code META-INF/services/com.sun.tools.javac.platform.PlatformProvider}.
30 *
31 *  <p><b>This is NOT part of any supported API.
32 *  If you write code that depends on this, you do so at your own risk.
33 *  This code and its internal interfaces are subject to change or
34 *  deletion without notice.</b>
35 */
36public interface PlatformProvider {
37
38    /**Names of platforms supported by this provider. Each returned name can be used as the key for -release.
39     *
40     * @return the platform keys
41     */
42    Iterable<String> getSupportedPlatformNames();
43
44    /**Create a description of a selected platform.
45     *
46     * @param platformName the name of the selected platform
47     * @param options additional parameter, which can be specified after ':' on the command line
48     * @return a PlatformDescription
49     * @throws PlatformNotSupported if the given platform is not supported
50     */
51    PlatformDescription getPlatform(String platformName, String options) throws PlatformNotSupported;
52
53    /**Throw if the given platform is not supported.
54     */
55    public class PlatformNotSupported extends Exception {
56        private static final long serialVersionUID = 1L;
57    }
58
59}
60