Interface Plugin
public interface Plugin
The interface for a javac plug-in.
The javac plug-in mechanism allows a user to specify one or more plug-ins on the javac command line, to be started soon after the compilation has begun. Plug-ins are identified by a user-friendly name. Each plug-in that is started will be passed an array of strings, which may be used to provide the plug-in with values for any desired options or other arguments.
Plug-ins are located via a ServiceLoader
, using the same class path as annotation processors (i.e. ANNOTATION_PROCESSOR_PATH
or -processorpath
).
It is expected that a typical plug-in will simply register a TaskListener
to be informed of events during the execution of the compilation, and that the rest of the work will be done by the task listener.
- Since:
- 1.8
Methods
Modifier and Type | Method | Description |
---|---|---|
String | getName() | Returns the user-friendly name of this plug-in. |
void | init(JavacTask task,
String... args) | Initializes the plug-in for a given compilation task. |
Methods
getName
String getName()
Returns the user-friendly name of this plug-in.
- Returns:
- the user-friendly name of the plug-in
init
void init(JavacTask task, String... args)
Initializes the plug-in for a given compilation task.
- Parameters:
-
task
- The compilation task that has just been started -
args
- Arguments, if any, for the plug-in
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/com/sun/source/util/Plugin.html