Класс ModelMBeanOperationInfo

javax.management.modelmbean.ModelMBeanOperationInfo

Все реализованные интерфейсы:: Serializable, Cloneable, DescriptorAccess, DescriptorRead

public class ModelMBeanOperationInfo extends MBeanOperationInfo implements DescriptorAccess

Объект ModelMBeanOperationInfo описывает операцию управления ModelMBean. Это подкласс MBeanOperationInfo, дополненный связанным дескриптором и реализацией интерфейса DescriptorAccess.

Поля дескриптора определены, но этот список не является исчерпывающим. Обратите внимание: если в столбце «Тип» указано Number, также можно использовать строку, содержащую десятичное представление Long.

Поля ModelMBeanOperationInfo
Имя	Тип	Значение
name	String	Имя операции.
descriptorType	String	Должно быть равно "operation".
class	String	Класс, в котором определён метод (полное имя).
role	String	Должно быть равно "operation", "getter" или "setter".
targetObject	Object	Объект, для которого выполняется этот метод.
targetType	String	Тип ссылки на объект targetObject. Возможные значения: ObjectReference \| Handle \| EJBHandle \| IOR \| RMIReference.
value	Object	Кэшированное значение операции.
displayName	String	Удобочитаемое отображаемое имя операции.
currencyTimeLimit	Number	Срок действия кэшированного значения.
lastUpdatedTimeStamp	Number	Время установки кэшированного значения.
visibility	Number	От 1 до 4, где 1 — всегда видимый, а 4 — редко видимый.
presentationString	String	Строка в формате XML, описывающая способ представления операции.

Дескриптор по умолчанию будет содержать поля name, descriptorType, displayName и role. Значением по умолчанию для полей name и displayName является имя операции.

Примечание: из-за несоответствий в предыдущих версиях этой спецификации рекомендуется не использовать отрицательные или нулевые значения для currencyTimeLimit. Чтобы указать, что кэшированное значение никогда не является действительным, не указывайте поле currencyTimeLimit. Чтобы указать, что оно всегда действительно, задайте для этого поля очень большое значение.

serialVersionUID этого класса равен 6532732096650090465L.

Начиная с:

1.5

См. также:

Краткое описание полей

Поля, объявленные в классе MBeanOperationInfo

ACTION, ACTION_INFO, INFO, UNKNOWN

Модификатор и тип	Поле	Описание
`static final int`	`ACTION`	Указывает, что операция подобна операции записи: она оказывает эффект, но не возвращает никаких сведений из MBean.
`static final int`	`ACTION_INFO`	Указывает, что операция одновременно подобна операциям чтения и записи: она оказывает эффект и также возвращает сведения из MBean.
`static final int`	`INFO`	Указывает, что операция подобна операции чтения: она возвращает сведения, но не изменяет состояние.
`static final int`	`UNKNOWN`	Указывает, что влияние операции неизвестно или не может быть выражено одним из других значений.

Поля, объявленные в классе MBeanFeatureInfo

description, name

Модификатор и тип	Поле	Описание
`protected String`	`description`	Удобочитаемое описание компонента.
`protected String`	`name`	Имя компонента.

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

Конструктор	Описание
`ModelMBeanOperationInfo(String description, Method operationMethod)`	Создаёт объект ModelMBeanOperationInfo с дескриптором по умолчанию.
`ModelMBeanOperationInfo(String description, Method operationMethod, Descriptor descriptor)`	Создаёт объект ModelMBeanOperationInfo.
`ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)`	Создаёт объект ModelMBeanOperationInfo с дескриптором по умолчанию.
`ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)`	Создаёт объект ModelMBeanOperationInfo.
`ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)`	Создаёт новый объект ModelMBeanOperationInfo на основе этого объекта ModelMBeanOperation.

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

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Создаёт и возвращает новый ModelMBeanOperationInfo, являющийся копией этого ModelMBeanOperationInfo.
`Descriptor`	`getDescriptor()`	Возвращает копию связанного дескриптора ModelMBeanOperationInfo.
`void`	`setDescriptor(Descriptor inDescriptor)`	Задаёт связанный дескриптор ModelMBeanOperationInfo (полная замена). Если новый дескриптор равен null, связанный дескриптор возвращается к значению по умолчанию.
`String`	`toString()`	Возвращает строку, содержащую полное содержимое ModelMBeanOperationInfo в удобочитаемом виде.

Методы, объявленные в классе MBeanOperationInfo

equals, getImpact, getReturnType, getSignature

Модификатор и тип	Метод	Описание
`boolean`	`equals(Object o)`	Сравнивает этот MBeanOperationInfo с другим.
`int`	`getImpact()`	Возвращает влияние метода: одно из значений `INFO, ACTION, ACTION_INFO, UNKNOWN`.
`String`	`getReturnType()`	Возвращает тип возвращаемого значения метода.
`MBeanParameterInfo[]`	`getSignature()`	Возвращает список параметров этой операции.

Методы, объявленные в классе MBeanFeatureInfo

getDescription, getName

Модификатор и тип	Метод	Описание
`String`	`getDescription()`	Возвращает удобочитаемое описание компонента.
`String`	`getName()`	Возвращает имя компонента.

Методы, объявленные в классе Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Модификатор и тип	Метод	Описание
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удалён в будущей версии. Финализация устарела и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.

Подробное описание конструкторов

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String description, Method operationMethod)

Создаёт объект ModelMBeanOperationInfo с дескриптором по умолчанию. Descriptor созданного объекта будет включать поля, добавленные аннотациями объекта Method, содержащими мета-аннотацию DescriptorKey.

Параметры:: description — Удобочитаемое описание операции.; operationMethod — Объект java.lang.reflect.Method, описывающий операцию MBean.

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String description, Method operationMethod, Descriptor descriptor)

Создаёт объект ModelMBeanOperationInfo. Descriptor созданного объекта будет включать поля, добавленные аннотациями объекта Method, содержащими мета-аннотацию DescriptorKey.

Параметры:: description — Удобочитаемое описание операции.; operationMethod — Объект java.lang.reflect.Method, описывающий операцию MBean.; descriptor — Экземпляр Descriptor, содержащий соответствующие метаданные для этого экземпляра ModelMBeanOperationInfo. Если он равен null, будет создан дескриптор по умолчанию. Если дескриптор не содержит поля "displayName" или "role", отсутствующие поля добавляются со значениями по умолчанию.
Исключения:: RuntimeOperationsException — Обёртывает IllegalArgumentException. Дескриптор недействителен; или поле дескриптора "name" не совпадает с именем операции; или поле дескриптора "DescriptorType" не равно "operation"; или необязательное поле дескриптора "role" присутствует, но не равно "operation", "getter" или "setter".

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact)

Создаёт объект ModelMBeanOperationInfo с дескриптором по умолчанию.

Параметры:: name — Имя метода.; description — Удобочитаемое описание операции.; signature — Объекты MBeanParameterInfo, описывающие параметры (аргументы) метода.; type — Тип возвращаемого значения метода.; impact — Влияние метода: одно из значений INFO, ACTION, ACTION_INFO, UNKNOWN.

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)

Создаёт объект ModelMBeanOperationInfo.

Параметры:: name — Имя метода.; description — Удобочитаемое описание операции.; signature — Объекты MBeanParameterInfo, описывающие параметры (аргументы) метода.; type — Тип возвращаемого значения метода.; impact — Влияние метода: одно из значений INFO, ACTION, ACTION_INFO, UNKNOWN.; descriptor — Экземпляр Descriptor, содержащий соответствующие метаданные для этого экземпляра MBeanOperationInfo. Если он равен null, будет создан дескриптор по умолчанию. Если дескриптор не содержит полей "displayName" или "role", отсутствующие поля добавляются со значениями по умолчанию.
Исключения:: RuntimeOperationsException — Обёртывает IllegalArgumentException. Дескриптор недействителен; или поле дескриптора "name" не совпадает с именем операции; или поле дескриптора "DescriptorType" не равно "operation"; или необязательное поле дескриптора "role" присутствует, но не равно "operation", "getter" или "setter".

ModelMBeanOperationInfo

public ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)

Создаёт новый объект ModelMBeanOperationInfo на основе этого объекта ModelMBeanOperation.

Параметры:: inInfo — ModelMBeanOperationInfo, который требуется скопировать

Подробное описание методов

clone

public Object clone()

Создаёт и возвращает новый ModelMBeanOperationInfo, являющийся копией этого ModelMBeanOperationInfo.

Переопределяет:

clone в классе MBeanOperationInfo

Возвращает:

копию этого экземпляра.

См. также:

getDescriptor

public Descriptor getDescriptor()

Возвращает копию связанного дескриптора ModelMBeanOperationInfo.

Определено в:

getDescriptor в интерфейсе DescriptorRead

Переопределяет:

getDescriptor в классе MBeanFeatureInfo

Возвращает:

Дескриптор, связанный с объектом ModelMBeanOperationInfo.

См. также:

setDescriptor

public void setDescriptor(Descriptor inDescriptor)

Задаёт связанный дескриптор ModelMBeanOperationInfo (полная замена). Если новый дескриптор равен null, связанный дескриптор возвращается к значению по умолчанию. Перед присваиванием дескриптор проверяется. Если новый дескриптор недействителен, выбрасывается RuntimeOperationsException, обёртывающий IllegalArgumentException.

Определено в:

setDescriptor в интерфейсе DescriptorAccess

Параметры:

inDescriptor — заменяет дескриптор, связанный с ModelMBeanOperation.

Исключения:

RuntimeOperationsException — Обёртывает IllegalArgumentException в случае недействительного дескриптора.

См. также:

toString

public String toString()

Возвращает строку, содержащую полное содержимое ModelMBeanOperationInfo в удобочитаемом виде.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление объекта

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