模块  jdk.jconsole
软件包  com.sun.tools.jconsole

Class JConsolePlugin

  • public abstract class JConsolePlugin
extends Object
    一个JConsole插件类。 JConsole使用service provider机制来搜索JConsole插件。 用户可以在包含名为的文件的jar文件中提供其JConsole插件 
     META-INF/services/com.sun.tools.jconsole.JConsolePlugin

    该文件包含每个插件的一行，例如， 

     com.sun.example.JTop

    这是实现JConsolePlugin的类的完全限定类名。

    要在JConsole中加载JConsole插件，请运行： 

     jconsole -pluginpath <plugin-path>

    其中<plugin-path>指定要查找的JConsole插件的路径，可以是目录或jar文件。 多个路径由平台的路径分隔符分隔。

    为连接创建新的JConsole窗口时，将创建每个JConsolePlugin的实例。 JConsoleContext对象在构造时不可用。 创建插件对象后，JConsole将为插件设置JConsoleContext对象。 然后它将调用其getTabs方法并将返回的选项卡添加到JConsole窗口。

    从以下版本开始：
    1.6
    另请参见：
    ServiceLoader

    • 构造方法详细信息

      • JConsolePlugin

        protected JConsolePlugin()
        构造函数。

    • 方法详细信息

      • setContext

        public final void setContext​(JConsoleContext context)
        设置表示与应用程序的连接的JConsoleContext对象。 创建插件后和调用getTabs()之前，此方法仅调用一次。 调用此方法时，给定的context可以位于任何connection state中 。
        参数
        context - JConsoleContext对象

      • getContext

        public final JConsoleContext getContext()
        返回表示与应用程序的连接的JConsoleContext对象。 如果在初始化context之前调用它，则此方法可能返回null 。
        结果
        表示与应用程序的连接的JConsoleContext对象。

      • getTabs

        public abstract Map<String,​JPanel> getTabs()
        返回要在JConsole窗口中添加的选项卡。

        返回的映射包含要在JConsole窗口的选项卡式窗格中添加的每个选项卡的一个条目，其中选项卡名称为键， JPanel对象为值。 如果此插件未添加任何选项卡，则此方法返回空映射。 在新的连接时间，将从Event Dispatch Thread调用此方法一次。

        结果
        选项卡名称的映射和表示要在JConsole窗口中添加的选项卡的JPanel对象; 或者一张空地图。

      • newSwingWorker

        public abstract SwingWorker<?,​?> newSwingWorker()
        返回SwingWorker，以与JConsole更新GUI相同的间隔执行此插件的GUI更新。

        JConsole以为连接指定的间隔调度GUI更新。 每次更新时都会调用此方法，以获取每个插件的SwingWorker 。

        如果出现以下情况，JConsole将调用execute()方法来安排返回的SwingWorker执行：


        否则， SwingWorker对象将无法安排工作。

        插件可以安排自己的GUI更新，此方法将返回null 。

        结果
        a SwingWorker执行GUI更新; 或null 。

      • dispose

        public void dispose()
        处理此插件。 JConsole调用此方法以通知此插件将被丢弃，并且应该释放它已分配的任何资源。 调用此方法时， JConsoleContext可以位于任何connection state中 。

      • addContextPropertyChangeListener

        public final void addContextPropertyChangeListener​(PropertyChangeListener listener)
        为此插件添加PropertyChangeListener到JConsoleContext对象。 当JConsoleContext对象可能或可能不可用时，此方法是此插件注册侦听器的便捷方法。

        例如，插件构造函数可以调用此方法来注册侦听器以侦听connectionState属性更改，并且侦听器将在可用时添加到JConsoleContext对象。

        参数
        listener - 要添加的 PropertyChangeListener
        异常
        NullPointerException - 如果 listener是 null 。

      • removeContextPropertyChangeListener

        public final void removeContextPropertyChangeListener​(PropertyChangeListener listener)
        从此插件的JConsoleContext对象的侦听器列表中删除PropertyChangeListener 。 如果从未添加listener则不会抛出任何异常并且不执行任何操作。
        参数
        listener - 要删除的 PropertyChangeListener
        异常
        NullPointerException - 如果 listener是 null 。