Module  jdk.jconsole
软件包  com.sun.tools.jconsole

Class JConsolePlugin


  • public abstract class JConsolePlugin
extends Object
    一个JConsole插件类。 JConsole使用service provider机制来搜索JConsole插件。 用户可以将JConsole插件提供到包含名为文件的jar文件中 
     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对象作为值。 如果此插件没有添加标签，此方法返回一个空的地图。 在新的连接时间，将从事件调度线程一次调用此方法。

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

      • newSwingWorker

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

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

        JConsole将调用execute()方法来计划返回的SwingWorker执行：


        否则， SwingWorker对象不会被安排工作。

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

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

      • dispose

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

      • addContextPropertyChangeListener

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

        例如，一个插件构造函数可以调用这个方法来注册监听器来监听connectionState的属性更改，并且当它可用时，监听器将被添加到JConsoleContext对象中。

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

      • removeContextPropertyChangeListener

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