Класс JConsolePlugin
public abstract class JConsolePlugin extends Object
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
- См. также:
Краткое описание конструкторов
| Модификатор | Конструктор | Описание |
|---|---|---|
protected |
Конструктор. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
final void |
addContextPropertyChangeListener |
Добавляет PropertyChangeListener к объекту JConsoleContext для этого плагина. |
void |
dispose() |
Удаляет этот плагин. |
final JConsoleContext |
getContext() |
Возвращает объект JConsoleContext, представляющий соединение с приложением. |
abstract Map |
getTabs() |
Возвращает вкладки, которые должны быть добавлены в окно JConsole. |
abstract SwingWorker |
newSwingWorker() |
Возвращает SwingWorker для выполнения обновления графического интерфейса для этого плагина с тем же интервалом, что и JConsole обновляет графический интерфейс. |
final void |
removeContextPropertyChangeListener |
Удаляет PropertyChangeListener из списка слушателей объекта JConsoleContext для этого плагина. |
final void |
setContext |
Устанавливает объект JConsoleContext, представляющий подключение к приложению. |
Подробное описание конструкторов
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, с именем вкладки в качестве ключа и объектом 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()
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, 2023, 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/21/docs/api/jdk.jconsole/com/sun/tools/jconsole/JConsolePlugin.html