jjg@1416: /*
jjg@1416:  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
jjg@1416:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jjg@1416:  *
jjg@1416:  * This code is free software; you can redistribute it and/or modify it
jjg@1416:  * under the terms of the GNU General Public License version 2 only, as
jjg@1416:  * published by the Free Software Foundation.  Oracle designates this
jjg@1416:  * particular file as subject to the "Classpath" exception as provided
jjg@1416:  * by Oracle in the LICENSE file that accompanied this code.
jjg@1416:  *
jjg@1416:  * This code is distributed in the hope that it will be useful, but WITHOUT
jjg@1416:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jjg@1416:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jjg@1416:  * version 2 for more details (a copy is included in the LICENSE file that
jjg@1416:  * accompanied this code).
jjg@1416:  *
jjg@1416:  * You should have received a copy of the GNU General Public License version
jjg@1416:  * 2 along with this work; if not, write to the Free Software Foundation,
jjg@1416:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jjg@1416:  *
jjg@1416:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jjg@1416:  * or visit www.oracle.com if you need additional information or have any
jjg@1416:  * questions.
jjg@1416:  */
jjg@1416: package com.sun.source.util;
jjg@1416: 
jjg@1416: import java.util.ServiceLoader;
jjg@1416: import javax.tools.StandardLocation;
jjg@1416: 
jjg@1416: /**
jjg@1416:  * The interface for a javac plug-in.
jjg@1416:  *
jjg@1416:  * <p>The javac plug-in mechanism allows a user to specify one or more plug-ins
jjg@1416:  * on the javac command line, to be started soon after the compilation
jjg@1416:  * has begun. Plug-ins are identified by a user-friendly name. Each plug-in that
jjg@1416:  * is started will be passed an array of strings, which may be used to
jjg@1416:  * provide the plug-in with values for any desired options or other arguments.
jjg@1416:  *
jjg@1416:  * <p>Plug-ins are located via a {@link ServiceLoader},
jjg@1416:  * using the same class path as annotation processors (i.e.
jjg@1416:  * {@link StandardLocation#PROCESSOR_PATH PROCESSOR_PATH} or
jjg@1416:  * {@code -processorpath}).
jjg@1416:  *
jjg@1416:  * <p>It is expected that a typical plug-in will simply register a
jjg@1416:  * {@link TaskListener} to be informed of events during the execution
jjg@1416:  * of the compilation, and that the rest of the work will be done
jjg@1416:  * by the task listener.
jjg@1416:  *
jjg@1416:  * @since 1.8
jjg@1416:  */
jjg@1416: public interface Plugin {
jjg@1416:     /**
jjg@1416:      * Get the user-friendly name of this plug-in.
jjg@1416:      * @return the user-friendly name of the plug-in
jjg@1416:      */
jjg@1416:     String getName();
jjg@1416: 
jjg@1416:     /**
jjg@1416:      * Invoke the plug-in for a given compilation task.
jjg@1416:      * @param task The compilation task that has just been started
jjg@1416:      * @param args Arguments, if any, for the plug-in
jjg@1416:      */
jjg@1416:     void call(JavacTask task, String... args);
jjg@1416: }