Класс ModelMBeanAttributeInfo

javax.management.modelmbean.ModelMBeanAttributeInfo

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

public class ModelMBeanAttributeInfo extends MBeanAttributeInfo implements DescriptorAccess

Объект ModelMBeanAttributeInfo описывает атрибут ModelMBean. Он является подклассом MBeanAttributeInfo, дополненным связанным дескриптором и реализацией интерфейса 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	Срок действия value: <0 — никогда, =0 — всегда, >0 — число секунд.
lastUpdatedTimeStamp	Number	Время установки value.
visibility	Number	От 1 до 4, где 1 означает «всегда видимый», а 4 — «редко видимый».
presentationString	String	Строка в формате XML для представления данных.

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

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

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

Начиная с версии:

1.5

См. также:

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

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

description, name

Модификатор и тип	Поле	Описание
`protected String`	`description`	Человекочитаемое описание функционального элемента.
`protected String`	`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()`	Получает копию связанного дескриптора для ModelMBeanAttributeInfo.
`void`	`setDescriptor(Descriptor inDescriptor)`	Задает связанный дескриптор (полная замена) для ModelMBeanAttributeDescriptor.
`String`	`toString()`	Возвращает человекочитаемое представление экземпляра ModelMBeanAttributeInfo.

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

equals, getType, isIs, isReadable, isWritable

Модификатор и тип	Метод	Описание
`boolean`	`equals(Object o)`	Сравнивает этот MBeanAttributeInfo с другим.
`String`	`getType()`	Возвращает имя класса атрибута.
`boolean`	`isIs()`	Указывает, имеется ли у этого атрибута метод доступа "is".
`boolean`	`isReadable()`	Указывает, можно ли прочитать значение атрибута.
`boolean`	`isWritable()`	Указывает, можно ли записывать новые значения в атрибут.

Методы, объявленные в классе 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()`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного времени.

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

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()

Получает копию связанного дескриптора для ModelMBeanAttributeInfo.

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

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

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

getDescriptor в классе MBeanFeatureInfo

Возвращает:

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

См. также:

setDescriptor

public void setDescriptor(Descriptor inDescriptor)

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

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

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

Параметры:

inDescriptor — заменяет Descriptor, связанный с ModelMBeanAttributeInfo

Исключения:

RuntimeOperationsException — оборачивает IllegalArgumentException, вызванное недопустимым Descriptor

См. также:

clone

public Object clone()

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

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

clone в классе MBeanAttributeInfo

Возвращает:

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

Исключения:

RuntimeOperationsException — при недопустимом значении для имен полей или значений полей. Это исключение будет выброшено, если по какой-либо причине не удастся создать дескриптор.

См. также:

toString

public String toString()

Возвращает человекочитаемое представление экземпляра ModelMBeanAttributeInfo.

Переопределяет:: 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.