compact3

javax.management.timer

Интерфейс TimerMBean

Все Известные Классы с реализацией:

Таймер

public interface TimerMBean

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

С тех пор:

1.5

Сводка метода

Модификатор и Тип	Метод и Описание
Целое число	addNotification(String type, String message, Object userData, Date date) Создает новое уведомление о таймере с указанным type, message и userData и вставляет это в список уведомлений с данной датой и нулевой период и число возникновений.
Целое число	addNotification(String type, String message, Object userData, Date date, long period) Создает новое уведомление о таймере с указанным type, message и userData и вставляет это в список уведомлений с данной датой и период и нулевое число возникновений.
Целое число	addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences) Создает новое уведомление о таймере с указанным type, message и userData и вставляет это в список уведомлений с данной датой, период и число возникновений.
Целое число	addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) Создает новое уведомление о таймере с указанным type, message и userData и вставляет это в список уведомлений с данной датой, период и число возникновений.
Vector<Integer>	getAllNotificationIDs() Получает все идентификаторы уведомления о таймере, зарегистрированные в список уведомлений.
Дата	getDate(Integer id) Получает копию даты, связанной с уведомлением о таймере.
Булев	getFixedRate(Integer id) Получает копию флага, указывающего, выполняется ли периодическое уведомление в фиксированной задержке или в с фиксированной процентной ставкой.
int	getNbNotifications() Получает число уведомлений о таймере, зарегистрированных в список уведомлений.
Долго	getNbOccurences(Integer id) Получает копию остающегося числа возникновений, связанных с уведомлением о таймере.
Vector<Integer>	getNotificationIDs(String type) Получает все идентификаторы уведомлений о таймере, соответствующих указанному типу.
Строка	getNotificationMessage(Integer id) Получает уведомление о таймере детализированное сообщение, соответствующее указанному идентификатору.
Строка	getNotificationType(Integer id) Получает тип уведомления о таймере, соответствующий указанному идентификатору.
Объект	getNotificationUserData(Integer id) Получает пользовательский объект данных уведомления о таймере, соответствующий указанному идентификатору.
Долго	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() Останавливает таймер.

Деталь метода

запустить

void start()

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

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

остановиться

void stop()

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

addNotification

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

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

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

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

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

Параметры:

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

message - Уведомление о таймере детализированное сообщение.

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

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

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

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

fixedRate - Если true и если уведомление будет периодическим, то уведомление планируется со схемой выполнения с фиксированной процентной ставкой. Если false и если уведомление будет периодическим, то уведомление планируется со схемой выполнения фиксированной задержки. Проигнорированный, если уведомление не является периодическим.

Возвраты:

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

Броски:

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

См. Также:

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

addNotification

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

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

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

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

В случае периодического уведомления, использует схему выполнения фиксированной задержки, как определено в Timer. Чтобы использовать схему выполнения с фиксированной процентной ставкой, использовать addNotification(String, String, Object, Date, long, long, boolean) вместо этого.

Параметры:

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

message - Уведомление о таймере детализированное сообщение.

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

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

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

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

Возвраты:

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

Броски:

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

См. Также:

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 и вставляет это в список уведомлений с данной датой и период и нулевое число возникновений.

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

Возвраты:

Тип уведомления о таймере или нуль, если идентификатор не отображается ни на какое уведомление о таймере, зарегистрированное для этого таймера MBean.

getNotificationMessage

String getNotificationMessage(Integer id)

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

Параметры:

id - Идентификатор уведомления о таймере.

Возвраты:

Детализированное сообщение уведомления о таймере или нуль, если идентификатор не отображается ни на какое уведомление о таймере, зарегистрированное для этого таймера MBean.

getNotificationUserData

Object getNotificationUserData(Integer id)

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

Параметры:

id - Идентификатор уведомления о таймере.

Возвраты:

Пользовательский объект данных уведомления о таймере или нуль, если идентификатор не отображается ни на какое уведомление о таймере, зарегистрированное для этого таймера MBean.

getDate

Date getDate(Integer id)

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

Параметры:

id - Идентификатор уведомления о таймере.

Возвраты:

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

getPeriod

Long getPeriod(Integer id)

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

Параметры:

id - Идентификатор уведомления о таймере.

Возвраты:

Копия периода или нуля, если идентификатор не отображается ни на какое уведомление о таймере, зарегистрированное для этого таймера MBean.

getNbOccurences

Long getNbOccurences(Integer id)

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

Параметры:

id - Идентификатор уведомления о таймере.

Возвраты:

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

getFixedRate

Boolean getFixedRate(Integer id)

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

Параметры:

id - Идентификатор уведомления о таймере.

Возвраты:

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

getSendPastNotifications

boolean getSendPastNotifications()

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

Возвраты:

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

См. Также:

setSendPastNotifications(boolean)

setSendPastNotifications

void setSendPastNotifications(boolean value)

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

Параметры:

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

См. Также:

getSendPastNotifications()

isActive

boolean isActive()

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

Возвраты:

true если таймер MBean является активным, false иначе.

isEmpty

boolean isEmpty()

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

Возвраты:

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