Интерфейс 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)

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

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

getNotificationType

String getNotificationType(Integer id)

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

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

getNotificationMessage

String getNotificationMessage(Integer id)

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

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

getNotificationUserData

Object getNotificationUserData(Integer id)

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

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

getDate

Date getDate(Integer id)

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

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

getPeriod

Long getPeriod(Integer id)

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

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

getNbOccurences

Long getNbOccurences(Integer id)

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

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

getFixedRate

Boolean getFixedRate(Integer id)

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

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

getSendPastNotifications

boolean getSendPastNotifications()

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

Returns:

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

See Also:

setSendPastNotifications

void setSendPastNotifications(boolean value)

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

Parameters:

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

See Also:

isActive

boolean isActive()

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

Returns:: true, если таймер MBean активен, false в противном случае.

isEmpty

boolean isEmpty()

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

Returns:: true, если список таймерных уведомлений пуст, false в противном случае.

© 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://download.java.net/java/early_access/jdk24/docs/api/java.management/javax/management/timer/TimerMBean.html