Spec-Zone.ru › OpenJDK 25

Класс 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. Затем JConsole вызывает метод getTabs и добавляет возвращенные вкладки в окно JConsole.

Начиная с:
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, представляющий подключение к приложению.

Методы, объявленные в классе 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.

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

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

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.

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

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

Spec-Zone.ru

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