Spec-Zone.ru › OpenJDK 25

Класс ModelMBeanAttributeInfo

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanAttributeInfo
javax.management.modelmbean.ModelMBeanAttributeInfo
Все реализуемые интерфейсы:
Serializable, Cloneable, DescriptorAccess, DescriptorRead
public class ModelMBeanAttributeInfo extends MBeanAttributeInfo implements DescriptorAccess

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

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

Поля ModelMBeanAttributeInfo
Имя Тип Значение
name String Имя атрибута.
descriptorType String Должно быть равно "attribute".
value Object Текущее (кэшированное) значение атрибута.
default Object Значение атрибута по умолчанию.
displayName String Имя атрибута, используемое при отображении.
getMethod String Имя дескриптора операции для метода get.
setMethod String Имя дескриптора операции для метода set.
protocolMap Descriptor См. раздел "Поддержка карты протоколов" в документе спецификации JMX. Сопоставления должны соответствовать атрибуту, а записи можно обновлять или дополнять во время выполнения.
persistPolicy String Одно из значений: OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never. См. раздел "Поля дескриптора MBean" в документе спецификации JMX.
persistPeriod Number Периодичность цикла сохранения в секундах. Используется, если persistPolicy равно "OnTimer" или "NoMoreOftenThan".
currencyTimeLimit Number Как долго действительно значение: <0 — никогда, =0 — всегда, >0 — количество секунд.
lastUpdatedTimeStamp Number Время установки значения.
visibility Number От 1 до 4, где 1 — всегда видимый, 4 — редко видимый.
presentationString String Строка в формате XML для представления данных.

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

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

serialVersionUID этого класса: 6181543027787327345L.

С версии:
1.5
См. также:
  • Сериализованное представление

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

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

description, name

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

Конструктор Описание
ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter)
Создает объект ModelMBeanAttributeInfo с дескриптором по умолчанию.
ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter, Descriptor descriptor)
Создает объект ModelMBeanAttributeInfo.
ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)
Создает объект ModelMBeanAttributeInfo с дескриптором по умолчанию.
ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
Создает объект ModelMBeanAttributeInfo.
ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo)
Создает новый объект ModelMBeanAttributeInfo на основе этого объекта ModelMBeanAttributeInfo.

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

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

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

equals, getType, isIs, isReadable, isWritable

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

getDescription, getName

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

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

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

ModelMBeanAttributeInfo

public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter) throws IntrospectionException
Создает объект ModelMBeanAttributeInfo с дескриптором по умолчанию. Descriptor созданного объекта будет включать поля, добавленные аннотациями объектов Method, содержащих метааннотацию DescriptorKey.
Параметры:
name — имя атрибута.
description — удобочитаемое описание атрибута. Необязательно.
getter — метод, используемый для чтения значения атрибута. Может быть null, если свойство доступно только для записи.
setter — метод, используемый для записи значения атрибута. Может быть null, если атрибут доступен только для чтения.
Вызывает:
IntrospectionException — обнаружена проблема согласованности в определении этого атрибута.

ModelMBeanAttributeInfo

public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter, Descriptor descriptor) throws IntrospectionException
Создает объект ModelMBeanAttributeInfo. Descriptor созданного объекта будет включать поля, добавленные аннотациями объектов Method, содержащих метааннотацию DescriptorKey.
Параметры:
name — имя атрибута.
description — удобочитаемое описание атрибута. Необязательно.
getter — метод, используемый для чтения значения атрибута. Может быть null, если свойство доступно только для записи.
setter — метод, используемый для записи значения атрибута. Может быть null, если атрибут доступен только для чтения.
descriptor — экземпляр Descriptor, содержащий соответствующие метаданные для этого экземпляра Attribute. Если он равен null, будет создан дескриптор по умолчанию. Если дескриптор не содержит поле "displayName", это поле добавляется в дескриптор со значением по умолчанию.
Вызывает:
IntrospectionException — обнаружена проблема согласованности в определении этого атрибута.
RuntimeOperationsException — оборачивает IllegalArgumentException. Дескриптор недействителен, либо поле дескриптора "name" не равно параметру name, либо поле дескриптора "descriptorType" не равно "attribute".

ModelMBeanAttributeInfo

public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)
Создает объект ModelMBeanAttributeInfo с дескриптором по умолчанию.
Параметры:
name — имя атрибута
type — тип или имя класса атрибута
description — удобочитаемое описание атрибута.
isReadable — true, если у атрибута есть метод получения значения; иначе false.
isWritable — true, если у атрибута есть метод установки значения; иначе false.
isIs — true, если у атрибута есть метод получения значения "is"; иначе false.

ModelMBeanAttributeInfo

public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
Создает объект ModelMBeanAttributeInfo.
Параметры:
name — имя атрибута
type — тип или имя класса атрибута
description — удобочитаемое описание атрибута.
isReadable — true, если у атрибута есть метод получения значения; иначе false.
isWritable — true, если у атрибута есть метод установки значения; иначе false.
isIs — true, если у атрибута есть метод получения значения "is"; иначе false.
descriptor — экземпляр Descriptor, содержащий соответствующие метаданные для этого экземпляра Attribute. Если он равен null, будет создан дескриптор по умолчанию. Если дескриптор не содержит поле "displayName", это поле добавляется в дескриптор со значением по умолчанию.
Вызывает:
RuntimeOperationsException — оборачивает IllegalArgumentException. Дескриптор недействителен, либо поле дескриптора "name" не равно параметру name, либо поле дескриптора "descriptorType" не равно "attribute".

ModelMBeanAttributeInfo

public ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo)
Создает новый объект ModelMBeanAttributeInfo на основе этого объекта ModelMBeanAttributeInfo. Будет создан дескриптор по умолчанию.
Параметры:
inInfo — объект ModelMBeanAttributeInfo, который необходимо скопировать

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

getDescriptor

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

setDescriptor

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

clone

public Object clone()
Создает и возвращает новый объект ModelMBeanAttributeInfo, являющийся копией этого объекта ModelMBeanAttributeInfo.
Переопределяет:
clone в классе MBeanAttributeInfo
Возвращает:
копию этого экземпляра.
Вызывает:
RuntimeOperationsException — при недопустимом значении имен или значений полей. Это исключение выбрасывается, если создание дескриптора завершается с ошибкой по любой причине.
См. также:
  • Cloneable

toString

public String toString()
Возвращает удобочитаемое представление экземпляра ModelMBeanAttributeInfo.
Переопределяет:
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/ModelMBeanAttributeInfo.html

Spec-Zone.ru

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