Интерфейс 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 и уведомление является периодическим, для него планируется выполнение с фиксированной частотой. Если false и уведомление является периодическим, для него планируется выполнение с фиксированной задержкой. Игнорируется, если уведомление не является периодическим.

Возвращает:

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

Вызывает исключение:

IllegalArgumentException — Дата является null, либо период или количество повторений отрицательны.

См. также:

addNotification

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

Для периодического уведомления используется схема выполнения с фиксированной задержкой, как указано в Timer. Чтобы использовать схему выполнения с фиксированной частотой, вместо этого используйте 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 и добавляет его в список уведомлений с заданными датой и периодом, но с нулевым количеством повторений.

Уведомление таймера будет повторяться непрерывно с заданным периодом, используя схему выполнения с фиксированной задержкой, как указано в Timer. Чтобы использовать схему выполнения с фиксированной частотой, вместо этого используйте 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.

getNotificationType

String getNotificationType(Integer id)

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

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

getNotificationMessage

String getNotificationMessage(Integer id)

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

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

getNotificationUserData

Object getNotificationUserData(Integer id)

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

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

getDate

Date getDate(Integer id)

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

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

getPeriod

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