Mercurial > jdk8-mips64-public > langtools / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/classes/com/sun/source/util/Plugin.java	Mon Nov 19 11:38:49 2012 -0800
     1.3 @@ -0,0 +1,64 @@
     1.4 +/*
     1.5 + * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +package com.sun.source.util;
    1.29 +
    1.30 +import java.util.ServiceLoader;
    1.31 +import javax.tools.StandardLocation;
    1.32 +
    1.33 +/**
    1.34 + * The interface for a javac plug-in.
    1.35 + *
    1.36 + * <p>The javac plug-in mechanism allows a user to specify one or more plug-ins
    1.37 + * on the javac command line, to be started soon after the compilation
    1.38 + * has begun. Plug-ins are identified by a user-friendly name. Each plug-in that
    1.39 + * is started will be passed an array of strings, which may be used to
    1.40 + * provide the plug-in with values for any desired options or other arguments.
    1.41 + *
    1.42 + * <p>Plug-ins are located via a {@link ServiceLoader},
    1.43 + * using the same class path as annotation processors (i.e.
    1.44 + * {@link StandardLocation#PROCESSOR_PATH PROCESSOR_PATH} or
    1.45 + * {@code -processorpath}).
    1.46 + *
    1.47 + * <p>It is expected that a typical plug-in will simply register a
    1.48 + * {@link TaskListener} to be informed of events during the execution
    1.49 + * of the compilation, and that the rest of the work will be done
    1.50 + * by the task listener.
    1.51 + *
    1.52 + * @since 1.8
    1.53 + */
    1.54 +public interface Plugin {
    1.55 +    /**
    1.56 +     * Get the user-friendly name of this plug-in.
    1.57 +     * @return the user-friendly name of the plug-in
    1.58 +     */
    1.59 +    String getName();
    1.60 +
    1.61 +    /**
    1.62 +     * Invoke the plug-in for a given compilation task.
    1.63 +     * @param task The compilation task that has just been started
    1.64 +     * @param args Arguments, if any, for the plug-in
    1.65 +     */
    1.66 +    void call(JavacTask task, String... args);
    1.67 +}