Интерфейс TimerMBean

Все известные реализующие классы:: Timer

public interface TimerMBean

Предоставляет интерфейс управления MBean таймера.

С:: 1.5

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

Модификатор и тип	Метод	Описание
`Integer`	`addNotification(String type, String message, Object userData, Date date)`	Создает новое уведомление таймера со значением `type`, `message` и `userData` и вставляет его в список уведомлений с заданной датой и нулевым периодом и количеством повторений.
`Integer`	`addNotification(String type, String message, Object userData, Date date, long period)`	Создает новое уведомление таймера со значением `type`, `message` и `userData` и вставляет его в список уведомлений с заданной датой и периодом и нулевым количеством повторений.
`Integer`	`addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences)`	Создает новое уведомление таймера со значением `type`, `message` и `userData` и вставляет его в список уведомлений с заданной датой, периодом и количеством повторений.
`Integer`	`addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate)`	Создает новое уведомление таймера со значением `type`, `message` и `userData` и вставляет его в список уведомлений с заданной датой, периодом и количеством повторений.
`Vector<Integer>`	`getAllNotificationIDs()`	Получает все идентификаторы уведомлений таймера, зарегистрированные в списке уведомлений.
`Date`	`getDate(Integer id)`	Получает копию даты, связанной с уведомлением таймера.
`Boolean`	`getFixedRate(Integer id)`	Получает копию флага, указывающего, выполняется ли периодическое уведомление с фиксированной задержкой или с фиксированной скоростью.
`int`	`getNbNotifications()`	Получает количество зарегистрированных уведомлений таймера в списке уведомлений.
`Long`	`getNbOccurences(Integer id)`	Получает копию оставшегося количества повторений, связанных с уведомлением таймера.
`Vector<Integer>`	`getNotificationIDs(String type)`	Получает все идентификаторы уведомлений таймера, соответствующие указанному типу.
`String`	`getNotificationMessage(Integer id)`	Получает подробное сообщение об уведомлении таймера, соответствующее указанному идентификатору.
`String`	`getNotificationType(Integer id)`	Получает тип уведомления таймера, соответствующий указанному идентификатору.
`Object`	`getNotificationUserData(Integer id)`	Получает объект пользовательских данных уведомления таймера, соответствующий указанному идентификатору.
`Long`	`getPeriod(Integer id)`	Получает копию периода (в миллисекундах), связанного с уведомлением таймера.
`boolean`	`getSendPastNotifications()`	Получает флаг, указывающий, отправляет ли таймер прошедшие уведомления.
`boolean`	`isActive()`	Проверяет, активен ли MBean таймера.
`boolean`	`isEmpty()`	Проверяет, пуст ли список уведомлений таймера.
`void`	`removeAllNotifications()`	Удаляет все уведомления таймера из списка уведомлений и сбрасывает счетчик, используемый для обновления идентификаторов уведомлений таймера.
`void`	`removeNotification(Integer id)`	Удаляет уведомление таймера, соответствующее указанному идентификатору, из списка уведомлений.
`void`	`removeNotifications(String type)`	Удаляет все уведомления таймера, соответствующие указанному типу, из списка уведомлений.
`void`	`setSendPastNotifications(boolean value)`	Устанавливает флаг, указывающий, отправляет ли таймер прошедшие уведомления или нет.
`void`	`start()`	Запускает таймер.
`void`	`stop()`	Останавливает таймер.

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

start

void start()

Запускает таймер.

Если одно или несколько уведомлений таймера находятся перед текущим временем в списке уведомлений, уведомление отправляется в соответствии с флагом sendPastNotifications и затем обновляется в соответствии с его периодом и оставшимся количеством вхождений. Если дата уведомления таймера остаётся раньше текущей даты, это уведомление просто удаляется из списка уведомлений.

stop

void stop()

Останавливает таймер.

addNotification

Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) throws IllegalArgumentException

Создаёт новое уведомление таймера с указанными type, message и userData и вставляет его в список уведомлений с заданной датой, периодом и количеством вхождений.

Если у уведомления таймера, которое нужно вставить, дата раньше текущей даты, метод ведёт себя так, как если бы указанная дата была текущей датой.
Для одноразовых уведомлений уведомление доставляется немедленно.
Для периодических уведомлений первое уведомление доставляется немедленно, а последующие уведомления разнесены во времени, как указано в параметре периода.

Обратите внимание, что после того, как уведомление таймера было добавлено в список уведомлений, его связанная дата, период и количество вхождений не могут быть обновлены.

В случае периодического уведомления значение параметра fixedRate используется для указания схемы выполнения, как указано в Timer.

Параметры:

type - Тип уведомления таймера.

message - Подробное сообщение уведомления таймера.

userData - Объект пользовательских данных уведомления таймера.

date - Дата, когда происходит уведомление.

period - Период уведомления таймера (в миллисекундах).

nbOccurences - Общее количество, которое будет отправлено уведомлением таймера.

fixedRate - Если true и если уведомление является периодическим, уведомление планируется со схемой выполнения fixed-rate. Если false и если уведомление является периодическим, уведомление планируется со схемой выполнения fixed-delay. Игнорируется, если уведомление не является периодическим.

Возвращает:

Идентификатор нового созданного уведомления таймера.

Исключения:

IllegalArgumentException - Дата null или период, или количество вхождений отрицательны.

См. также:

addNotification

Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences) throws IllegalArgumentException

В случае периодического уведомления используется схема выполнения fixed-delay, как указано в Timer. Для использования схемы выполнения fixed-rate используйте addNotification(String, String, Object, Date, long, long, boolean).

Параметры:

type - Тип уведомления таймера.

message - Подробное сообщение уведомления таймера.

userData - Объект пользовательских данных уведомления таймера.

date - Дата, когда происходит уведомление.

period - Период уведомления таймера (в миллисекундах).

nbOccurences - Общее количество, которое будет отправлено уведомлением таймера.

Возвращает:

Идентификатор нового созданного уведомления таймера.

Исключения:

IllegalArgumentException - Дата null или период, или количество вхождений отрицательны.

См. также:

addNotification

Integer addNotification(String type, String message, Object userData, Date date, long period) throws IllegalArgumentException

Создаёт новое уведомление таймера с указанными type, message и userData и вставляет его в список уведомлений с заданной датой и периодом и нулевым количеством вхождений.

Уведомление таймера будет повторяться непрерывно, используя период таймера, используя схему выполнения fixed-delay, как указано в Timer. Для использования схемы выполнения fixed-rate используйте addNotification(String, String, Object, Date, long, long, boolean).

Если у уведомления таймера, которое нужно вставить, дата раньше текущей даты, метод ведёт себя так, как если бы указанная дата была текущей датой. Первое уведомление доставляется немедленно, а последующие уведомления разнесены во времени, как указано в параметре периода.

Параметры:: type - Тип уведомления таймера.; message - Подробное сообщение уведомления таймера.; userData - Объект пользовательских данных уведомления таймера.; date - Дата, когда происходит уведомление.; period - Период уведомления таймера (в миллисекундах).
Возвращает:: Идентификатор нового созданного уведомления таймера.
Исключения:: IllegalArgumentException - Дата null или период отрицательны.

addNotification

Integer addNotification(String type, String message, Object userData, Date date) throws IllegalArgumentException

Создаёт новое уведомление таймера с указанными type, message и userData и вставляет его в список уведомлений с заданной датой и нулевыми периодом и количеством вхождений.

Уведомление таймера будет обработано один раз в указанную дату.

Если у уведомления таймера, которое нужно вставить, дата раньше текущей даты, метод ведёт себя так, как если бы указанная дата была текущей датой, и уведомление доставляется немедленно.

Параметры:: type - Тип уведомления таймера.; message - Подробное сообщение уведомления таймера.; userData - Объект пользовательских данных уведомления таймера.; date - Дата, когда происходит уведомление.
Возвращает:: Идентификатор нового созданного уведомления таймера.
Исключения:: IllegalArgumentException - Дата null.

removeNotification

void removeNotification(Integer id) throws InstanceNotFoundException

Удаляет уведомление таймера, соответствующее указанному идентификатору, из списка уведомлений.

Параметры:: id - Идентификатор уведомления таймера.
Исключения:: InstanceNotFoundException - Указанный идентификатор не соответствует ни одному уведомлению таймера в списке уведомлений этого MBean таймера.

removeNotifications

void removeNotifications(String type) throws InstanceNotFoundException

Удаляет все уведомления таймера, соответствующие указанному типу, из списка уведомлений.

Параметры:: type - Тип уведомления таймера.
Исключения:: InstanceNotFoundException - Указанный тип не соответствует ни одному уведомлению таймера в списке уведомлений этого MBean таймера.

removeAllNotifications

void removeAllNotifications()

Удаляет все уведомления таймера из списка уведомлений и сбрасывает счётчик, используемый для обновления идентификаторов уведомлений таймера.

getNbNotifications

int getNbNotifications()

Получает количество уведомлений таймера, зарегистрированных в списке уведомлений.

Возвращает:: Количество уведомлений таймера.

getAllNotificationIDs

Vector<Integer> getAllNotificationIDs()

Получает все идентификаторы уведомлений таймера, зарегистрированных в списке уведомлений.

Возвращает:: Вектор объектов Integer, содержащий все идентификаторы уведомлений таймера.
Вектор пуст, если для этого MBean таймера не зарегистрировано ни одного уведомления таймера.

getNotificationIDs

Vector<Integer> getNotificationIDs(String type)

Получает все идентификаторы уведомлений таймера, соответствующие указанному типу.

Параметры:: type - Тип уведомления таймера.
Возвращает:: Вектор объектов Integer, содержащий все идентификаторы уведомлений таймера с указанным type.
Вектор пуст, если для этого MBean таймера не зарегистрировано ни одного уведомления таймера с указанным type.

Тип уведомления таймера

String getNotificationType(Integer id)

Получает тип уведомления таймера, соответствующий указанному идентификатору.

Параметры:: id - Идентификатор уведомления таймера.
Возвращает:: Тип уведомления таймера или null, если идентификатор не сопоставлен ни одному зарегистрированному уведомлению таймера для данного экземпляра MBean таймера.

Сообщение уведомления таймера

String getNotificationMessage(Integer id)

Получает подробное сообщение уведомления таймера, соответствующее указанному идентификатору.

Параметры:: id - Идентификатор уведомления таймера.
Возвращает:: Подробное сообщение уведомления таймера или null, если идентификатор не сопоставлен ни одному зарегистрированному уведомлению таймера для данного экземпляра MBean таймера.

Данные пользователя уведомления таймера

Object getNotificationUserData(Integer id)

Получает объект данных пользователя уведомления таймера, соответствующий указанному идентификатору.

Параметры:: id - Идентификатор уведомления таймера.
Возвращает:: Объект данных пользователя уведомления таймера или null, если идентификатор не сопоставлен ни одному зарегистрированному уведомлению таймера для данного экземпляра MBean таймера.

Дата

Date getDate(Integer id)

Получает копию даты, связанной с уведомлением таймера.

Параметры:: id - Идентификатор уведомления таймера.
Возвращает:: Копию даты или null, если идентификатор не сопоставлен ни одному зарегистрированному уведомлению таймера для данного экземпляра MBean таймера.

Период

Long getPeriod(Integer id)

Получает копию периода (в миллисекундах), связанного с уведомлением таймера.

Параметры:: id - Идентификатор уведомления таймера.
Возвращает:: Копию периода или null, если идентификатор не сопоставлен ни одному зарегистрированному уведомлению таймера для данного экземпляра MBean таймера.

getNbOccurences

Long getNbOccurences(Integer id)

Получает копию оставшегося количества срабатываний, связанных с уведомлением таймера.

Параметры:: id - Идентификатор уведомления таймера.
Возвращает:: Копию оставшегося количества срабатываний или null, если идентификатор не сопоставлен ни одному зарегистрированному уведомлению таймера для данного экземпляра MBean таймера.

getFixedRate

Boolean getFixedRate(Integer id)

Получает копию флага, указывающего, выполняется ли периодическое уведомление с фиксированной задержкой или с фиксированной частотой.

Параметры:: id - Идентификатор уведомления таймера.
Возвращает:: Копию флага, указывающего, выполняется ли периодическое уведомление с фиксированной задержкой или с фиксированной частотой.

getSendPastNotifications

boolean getSendPastNotifications()

Получает флаг, указывающий, отправляет ли таймер прошедшие уведомления.

Возвращает:

Значение флага включения/выключения отправки прошедших уведомлений.

См. также:

setSendPastNotifications

void setSendPastNotifications(boolean value)

Устанавливает флаг, указывающий, отправляет ли таймер прошедшие уведомления.

Параметры:

value - Значение флага включения/выключения отправки прошедших уведомлений.

См. также:

isActive

boolean isActive()

Проверяет, активен ли экземпляр MBean таймера. Экземпляр MBean таймера помечается как активный при вызове метода start. Он становится неактивным при вызове метода stop.

Возвращает:: true если экземпляр MBean таймера активен, false в противном случае.

isEmpty

boolean isEmpty()

Проверяет, пуст ли список уведомлений таймера.

Возвращает:: true если список уведомлений таймера пуст, false в противном случае.

© 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/java.management/javax/management/timer/TimerMBean.html