Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/source/util/Plugin.java@c0f0c41cafa0 (annotated)
src/share/classes/com/sun/source/util/Plugin.java
Mon, 19 Nov 2012 11:38:49 -0800
- author
- jjg
- date
- Mon, 19 Nov 2012 11:38:49 -0800
- changeset 1416
- c0f0c41cafa0
- child 1457
- 064e372f273d
- permissions
- -rw-r--r--
8001098: Provide a simple light-weight "plug-in" mechanism for javac
Reviewed-by: mcimadamore
| jjg@1416 | 1 | /* |
| jjg@1416 | 2 | * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. |
| jjg@1416 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| jjg@1416 | 4 | * |
| jjg@1416 | 5 | * This code is free software; you can redistribute it and/or modify it |
| jjg@1416 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| jjg@1416 | 7 | * published by the Free Software Foundation. Oracle designates this |
| jjg@1416 | 8 | * particular file as subject to the "Classpath" exception as provided |
| jjg@1416 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| jjg@1416 | 10 | * |
| jjg@1416 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| jjg@1416 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| jjg@1416 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| jjg@1416 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| jjg@1416 | 15 | * accompanied this code). |
| jjg@1416 | 16 | * |
| jjg@1416 | 17 | * You should have received a copy of the GNU General Public License version |
| jjg@1416 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| jjg@1416 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| jjg@1416 | 20 | * |
| jjg@1416 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| jjg@1416 | 22 | * or visit www.oracle.com if you need additional information or have any |
| jjg@1416 | 23 | * questions. |
| jjg@1416 | 24 | */ |
| jjg@1416 | 25 | package com.sun.source.util; |
| jjg@1416 | 26 | |
| jjg@1416 | 27 | import java.util.ServiceLoader; |
| jjg@1416 | 28 | import javax.tools.StandardLocation; |
| jjg@1416 | 29 | |
| jjg@1416 | 30 | /** |
| jjg@1416 | 31 | * The interface for a javac plug-in. |
| jjg@1416 | 32 | * |
| jjg@1416 | 33 | * <p>The javac plug-in mechanism allows a user to specify one or more plug-ins |
| jjg@1416 | 34 | * on the javac command line, to be started soon after the compilation |
| jjg@1416 | 35 | * has begun. Plug-ins are identified by a user-friendly name. Each plug-in that |
| jjg@1416 | 36 | * is started will be passed an array of strings, which may be used to |
| jjg@1416 | 37 | * provide the plug-in with values for any desired options or other arguments. |
| jjg@1416 | 38 | * |
| jjg@1416 | 39 | * <p>Plug-ins are located via a {@link ServiceLoader}, |
| jjg@1416 | 40 | * using the same class path as annotation processors (i.e. |
| jjg@1416 | 41 | * {@link StandardLocation#PROCESSOR_PATH PROCESSOR_PATH} or |
| jjg@1416 | 42 | * {@code -processorpath}). |
| jjg@1416 | 43 | * |
| jjg@1416 | 44 | * <p>It is expected that a typical plug-in will simply register a |
| jjg@1416 | 45 | * {@link TaskListener} to be informed of events during the execution |
| jjg@1416 | 46 | * of the compilation, and that the rest of the work will be done |
| jjg@1416 | 47 | * by the task listener. |
| jjg@1416 | 48 | * |
| jjg@1416 | 49 | * @since 1.8 |
| jjg@1416 | 50 | */ |
| jjg@1416 | 51 | public interface Plugin { |
| jjg@1416 | 52 | /** |
| jjg@1416 | 53 | * Get the user-friendly name of this plug-in. |
| jjg@1416 | 54 | * @return the user-friendly name of the plug-in |
| jjg@1416 | 55 | */ |
| jjg@1416 | 56 | String getName(); |
| jjg@1416 | 57 | |
| jjg@1416 | 58 | /** |
| jjg@1416 | 59 | * Invoke the plug-in for a given compilation task. |
| jjg@1416 | 60 | * @param task The compilation task that has just been started |
| jjg@1416 | 61 | * @param args Arguments, if any, for the plug-in |
| jjg@1416 | 62 | */ |
| jjg@1416 | 63 | void call(JavacTask task, String... args); |
| jjg@1416 | 64 | } |
