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  */
  25 
  26 package com.sun.tools.javac.platform;
  27 
  28 /** A collection of platform descriptions that can be selected using {@code --release name}
  29  *  command line option.
  30  *  Register in {@code META-INF/services/com.sun.tools.javac.platform.PlatformProvider}.
  31  *
  32  *  <p><b>This is NOT part of any supported API.
  33  *  If you write code that depends on this, you do so at your own risk.
  34  *  This code and its internal interfaces are subject to change or
  35  *  deletion without notice.</b>
  36  */
  37 public interface PlatformProvider {
  38 
  39     /**Names of platforms supported by this provider. Each returned name can be used as the key for --release.
  40      *
  41      * @return the platform keys
  42      */
  43     Iterable<String> getSupportedPlatformNames();
  44 
  45     /**Create a description of a selected platform.
  46      *
  47      * @param platformName the name of the selected platform
  48      * @param options additional parameter, which can be specified after ':' on the command line
  49      * @return a PlatformDescription
  50      * @throws PlatformNotSupported if the given platform is not supported
  51      */
  52     PlatformDescription getPlatform(String platformName, String options) throws PlatformNotSupported;
  53 
  54     /**Throw if the given platform is not supported.
  55      */
  56     public class PlatformNotSupported extends Exception {
  57         private static final long serialVersionUID = 1L;
  58     }
  59 
  60 }