Spec-Zone.ru › OpenJDK 17

Класс JConsolePlugin

java.lang.Object
com.sun.tools.jconsole.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.

Since:
1.6
См. также:
  • ServiceLoader

Краткое описание конструкторов

JConsolePlugin()
Модификатор Конструктор Описание
protected
Конструктор.

Краткое описание методов

Модификатор и тип Метод Описание
final void addContextPropertyChangeListener(PropertyChangeListener listener)
Добавляет PropertyChangeListener к объекту JConsoleContext для этого плагина.
void dispose()
Удалить этот плагин.
final JConsoleContext getContext()
Возвращает объект JConsoleContext, представляющий подключение к приложению.
abstract Map<String,JPanel> getTabs()
Возвращает вкладки, которые необходимо добавить в окно JConsole.
abstract SwingWorker<?,?> newSwingWorker()
Возвращает SwingWorker для выполнения обновления пользовательского интерфейса для этого плагина с той же периодичностью, что и обновления JConsole пользовательского интерфейса.
final void removeContextPropertyChangeListener(PropertyChangeListener listener)
Удаляет PropertyChangeListener из списка слушателей объекта JConsoleContext для этого плагина.
final void setContext(JConsoleContext context)
Устанавливает объект JConsoleContext, представляющий подключение к приложению.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

JConsolePlugin

protected JConsolePlugin()
Конструктор.

Подробное описание методов

setContext

public final void setContext(JConsoleContext context)
Устанавливает объект JConsoleContext, представляющий подключение к приложению. Этот метод вызывается только один раз после создания плагина и перед вызовом getTabs(). Переданный context может находиться в любом состоянии connection state при вызове этого метода.
Параметры:
context - объект JConsoleContext

getContext

public final JConsoleContext getContext()
Возвращает объект JConsoleContext, представляющий подключение к приложению. Этот метод может вернуть null если он вызывается до инициализации context.
Возвращает:
объект JConsoleContext, представляющий подключение к приложению.

getTabs

public abstract Map<String,JPanel> getTabs()
Возвращает вкладки, которые необходимо добавить в окно JConsole.

Возвращаемый map содержит одну запись для каждой вкладки, которая должна быть добавлена ​​в вкладку JConsole, с именем вкладки в качестве ключа и объектом JPanel в качестве значения. Этот метод возвращает пустой map, если плагин не добавляет вкладку. Этот метод вызывается из потока обработки событий один раз при новом подключении.

Возвращает:
map имени вкладки и объекта JPanel, представляющего вкладки, которые необходимо добавить в окно JConsole; или пустой map.

newSwingWorker

public abstract SwingWorker<?,?> newSwingWorker()
Возвращает SwingWorker для выполнения обновления пользовательского интерфейса для этого плагина с той же периодичностью, что и обновления JConsole пользовательского интерфейса.

JConsole планирует обновление пользовательского интерфейса с заданным интервалом для подключения. Этот метод будет вызываться при каждом обновлении, чтобы получить SwingWorker для каждого плагина.

JConsole вызовет метод execute() для планирования выполнения возвращенного SwingWorker если:

  • объект SwingWorker не был выполнен (т. е. метод SwingWorker.getState() возвращает состояние PENDING); и
  • объект SwingWorker , возвращенный в предыдущем обновлении, завершил задачу, если он не был null (т. е. метод SwingWorker.isDone возвращает true).

В противном случае объект SwingWorker не будет запланирован на работу.

Плагин может запланировать собственное обновление пользовательского интерфейса, и этот метод вернет null.

Возвращает:
объект SwingWorker для выполнения обновления пользовательского интерфейса; или 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)
Удаляет PropertyChangeListener из списка слушателей объекта JConsoleContext для этого плагина. Если listener никогда не добавлялся, исключение не выбрасывается, и никаких действий не выполняется.
Параметры:
listener - удаляемый PropertyChangeListener
Исключения:
NullPointerException - если listener находится в состоянии null.

© 1993, 2021, 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/17/docs/api/jdk.jconsole/com/sun/tools/jconsole/JConsolePlugin.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API