Класс ModelMBeanAttributeInfo

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.

Since:

1.5

См. также:

Сериализованная форма

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

Поля, объявленные в классе javax.management.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.

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

equals, getType, isIs, isReadable, isWritable

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

getDescription, getName

Методы, объявленные в классе java.lang.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, содержащий соответствующие метаданные для этого экземпляра атрибута. Если 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, если атрибут имеет метод getter, иначе false.; isWritable - True, если атрибут имеет метод setter, иначе false.; isIs - True, если атрибут имеет getter-метод "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, если атрибут имеет метод getter, иначе false.; isWritable - True, если атрибут имеет метод setter, иначе false.; isIs - True, если атрибут имеет getter-метод "is", иначе false.; descriptor - Экземпляр Descriptor, содержащий соответствующие метаданные для этого экземпляра атрибута. Если null, создаётся дескриптор по умолчанию. Если дескриптор не содержит поля "displayName", это поле добавляется в дескриптор со значением по умолчанию.
Исключения:: RuntimeOperationsException - Оборачивает IllegalArgumentException для некорректного дескриптора.

ModelMBeanAttributeInfo

public ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo)

Создаёт новый объект ModelMBeanAttributeInfo из этого объекта ModelMBeanAttributeInfo. Будет создан дескриптор по умолчанию.

Параметры:: inInfo - дублируемый ModelMBeanAttributeInfo

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

getDescriptor

public Descriptor getDescriptor()

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

Унаследовано от:

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

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

getDescriptor в классе MBeanFeatureInfo

Возвращает:

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

См. также:

setDescriptor(javax.management.Descriptor)

setDescriptor

public void setDescriptor(Descriptor inDescriptor)

Устанавливает связанный дескриптор (полная замена) для ModelMBeanAttributeDescriptor. Если новый дескриптор равен null, связанный дескриптор восстанавливается до дескриптора по умолчанию. Дескриптор проверяется перед назначением. Если новый дескриптор некорректен, выбрасывается RuntimeOperationsException, содержащий IllegalArgumentException.

Унаследовано от:

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

Параметры:

inDescriptor - заменяет связанный дескриптор ModelMBeanAttributeInfo

Исключения:

RuntimeOperationsException - Оборачивает IllegalArgumentException для некорректного дескриптора

См. также:

getDescriptor()

clone

public Object clone()

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

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

clone в классе MBeanAttributeInfo

Возвращает:

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

Исключения:

RuntimeOperationsException - для недопустимого значения для поля Names или поля Values. Если создание дескриптора по какой-либо причине терпит неудачу, будет выброшено это исключение.

См. также:

Cloneable

toString

public String toString()

Возвращает удобочитаемый вид экземпляра ModelMBeanAttributeInfo.

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

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