Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/source/util/Plugin.java
src/share/classes/com/sun/source/util/Plugin.java
- changeset 0
- 959103a6100f
- child 2525
- 2eb010b6cb22
equal
deleted
inserted
replaced
| -1:000000000000 | 0:959103a6100f |
|---|---|
| 1 /* | |
| 2 * Copyright (c) 2005, 2013, 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 package com.sun.source.util; | |
| 26 | |
| 27 import java.util.ServiceLoader; | |
| 28 import javax.tools.StandardLocation; | |
| 29 | |
| 30 /** | |
| 31 * The interface for a javac plug-in. | |
| 32 * | |
| 33 * <p>The javac plug-in mechanism allows a user to specify one or more plug-ins | |
| 34 * on the javac command line, to be started soon after the compilation | |
| 35 * has begun. Plug-ins are identified by a user-friendly name. Each plug-in that | |
| 36 * is started will be passed an array of strings, which may be used to | |
| 37 * provide the plug-in with values for any desired options or other arguments. | |
| 38 * | |
| 39 * <p>Plug-ins are located via a {@link ServiceLoader}, | |
| 40 * using the same class path as annotation processors (i.e. | |
| 41 * {@link StandardLocation#ANNOTATION_PROCESSOR_PATH ANNOTATION_PROCESSOR_PATH} or | |
| 42 * {@code -processorpath}). | |
| 43 * | |
| 44 * <p>It is expected that a typical plug-in will simply register a | |
| 45 * {@link TaskListener} to be informed of events during the execution | |
| 46 * of the compilation, and that the rest of the work will be done | |
| 47 * by the task listener. | |
| 48 * | |
| 49 * @since 1.8 | |
| 50 */ | |
| 51 @jdk.Exported | |
| 52 public interface Plugin { | |
| 53 /** | |
| 54 * Get the user-friendly name of this plug-in. | |
| 55 * @return the user-friendly name of the plug-in | |
| 56 */ | |
| 57 String getName(); | |
| 58 | |
| 59 /** | |
| 60 * Initialize the plug-in for a given compilation task. | |
| 61 * @param task The compilation task that has just been started | |
| 62 * @param args Arguments, if any, for the plug-in | |
| 63 */ | |
| 64 void init(JavacTask task, String... args); | |
| 65 } |
