Spec-Zone.ru › OpenJDK 25

Класс ModelMBeanOperationInfo

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanOperationInfo
javax.management.modelmbean.ModelMBeanOperationInfo
Все реализованные интерфейсы:
Serializable, Cloneable, DescriptorAccess, DescriptorRead
public class ModelMBeanOperationInfo extends MBeanOperationInfo implements DescriptorAccess

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

Поля дескриптора определены, но не ограничиваются перечисленными ниже. Обратите внимание: если в столбце Type указано Number, также можно использовать String, представляющую собой десятичную запись 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

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

description, 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

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

getDescription, getName

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

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

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

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
Возвращает:
копию этого экземпляра.
См. также:
  • Cloneable

getDescriptor

public Descriptor getDescriptor()
Возвращает копию связанного дескриптора ModelMBeanOperationInfo.
Определено в:
getDescriptor в интерфейсе DescriptorRead
Переопределяет:
getDescriptor в классе MBeanFeatureInfo
Возвращает:
дескриптор, связанный с объектом ModelMBeanOperationInfo.
См. также:
  • setDescriptor(Descriptor)

setDescriptor

public void setDescriptor(Descriptor inDescriptor)
Задаёт связанный дескриптор ModelMBeanOperationInfo (полная замена). Если новый дескриптор равен null, связанный дескриптор заменяется дескриптором по умолчанию. Перед назначением дескриптор проверяется. Если новый дескриптор недействителен, генерируется RuntimeOperationsException, оборачивающее IllegalArgumentException.
Определено в:
setDescriptor в интерфейсе DescriptorAccess
Параметры:
inDescriptor — заменяет дескриптор, связанный с ModelMBeanOperation.
Исключения:
RuntimeOperationsException — оборачивает IllegalArgumentException, если дескриптор недействителен.
См. также:
  • getDescriptor()

toString

public String toString()
Возвращает строку, содержащую полное содержимое ModelMBeanOperationInfo в удобочитаемом виде.
Переопределяет:
toString в классе Object
Возвращает:
строковое представление объекта

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, где приведены более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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/modelmbean/ModelMBeanOperationInfo.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API