Module jdk.compiler
Package com.sun.source.util

Interface Plugin

public interface Plugin
javac插件的接口。

javac插件机制允许用户在javac命令行上指定一个或多个插件，在编译开始后不久启动。插件由用户友好的名称标识。每个启动的插件将被传递一个字符串数组，该数组可用于为插件提供任何所需选项或其他参数的值。

通过ServiceLoader定位插件，使用与注解处理器相同的类路径（即ANNOTATION_PROCESSOR_PATH或-processorpath）。

通常期望一个典型的插件将简单地注册一个TaskListener以便在编译执行过程中通知事件，其余工作将由任务监听器完成。

自 JDK 版本:
1.8

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    autoStart()
    返回此插件是否应自动启动，即使在命令行选项中没有明确指定。
    String
    getName()
    返回此插件的用户友好名称。
    void
    init(JavacTask task, String... args)
    为给定的编译任务初始化插件。

  • Method Details

    • getName

      String getName()
      返回此插件的用户友好名称。
      返回:
      插件的用户友好名称

    • init

      void init(JavacTask task, String... args)
      为给定的编译任务初始化插件。
      参数:
      task - 刚刚启动的编译任务
      args - 插件的参数（如果有）

    • autoStart

      default boolean autoStart()
      返回此插件是否应自动启动，即使在命令行选项中没有明确指定。

      此方法将被javac调用所有通过服务加载器定位的插件。如果该方法返回true，则插件将在没有明确命令行选项初始化的情况下使用空字符串参数数组进行初始化。

      返回:
      此插件是否应自动启动