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

Parameters:

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

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

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

date - Дата срабатывания уведомления.

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

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

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

Returns:

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

Throws:

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

See Also:

addNotification(String, String, Object, Date, long, long)

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

Parameters:

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

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

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

date - Дата срабатывания уведомления.

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

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

Returns:

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

Throws:

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

See Also:

addNotification(String, String, Object, Date, long, long, boolean)

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) вместо этого.

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

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

addNotification

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

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

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

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

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

removeNotification

void removeNotification(Integer id) throws InstanceNotFoundException

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

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

removeNotifications

void removeNotifications(String type) throws InstanceNotFoundException

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

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

removeAllNotifications

void removeAllNotifications()

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

getNbNotifications

int getNbNotifications()

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

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

getAllNotificationIDs

Vector<Integer> getAllNotificationIDs()

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

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

getNotificationIDs

Vector<Integer> getNotificationIDs(String type)

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

Parameters:: type - Тип уведомления таймера.
Returns:: Вектор объектов 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 таймера уведомлением.

Количество повторений

Long getNbOccurences(Integer id)

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

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

Фиксированный темп

Boolean getFixedRate(Integer id)

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

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

Отправка прошедших уведомлений

boolean getSendPastNotifications()

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

Возвращает:

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

См. также:

setSendPastNotifications(boolean)

Установить отправку прошедших уведомлений

void setSendPastNotifications(boolean value)

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

Параметры:

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

См. также:

getSendPastNotifications()

Активен

boolean isActive()

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

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

Пустой

boolean isEmpty()

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

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

© 1993, 2021, 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/17/docs/api/java.management/javax/management/timer/TimerMBean.html