Класс 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.

С версии:

1.6

См. также:

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Проверяет, «равен ли» этот объект другому объекту.
`protected void`	`finalize()`	Устарело, планируется удаление: этот элемент API может быть удалён в будущей версии. Финализация объявлена устаревшей и может быть удалена в одном из следующих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает значение хеш-кода для этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать до тех пор, пока он не будет пробуждён, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать до тех пор, пока он не будет пробуждён, обычно в результате вызова notify или interrupt, либо пока не истечёт заданное время.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать до тех пор, пока он не будет пробуждён, обычно в результате вызова notify или interrupt, либо пока не истечёт заданное время.

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

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.

© 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.