Класс 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 с добавлением связанного описателя и реализацией интерфейса DescriptorAccess.
Поля в описателе определены, но не ограничиваются следующими. Обратите внимание, что когда Тип в этой таблице — Number, можно также использовать строку, представляющую десятичное представление Long.
| Имя | Тип | Значение |
|---|---|---|
| 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
- См. также:
- Сериализованная форма
Поля
Поля, унаследованные от класса javax.management.MBeanFeatureInfo
description, name Конструкторы
| Конструктор и описание |
|---|
ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo) Создаёт новый объект ModelMBeanAttributeInfo, являющийся дубликатом этого объекта ModelMBeanAttributeInfo. |
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. |
Методы
| Модификатор и тип | Метод и описание |
|---|---|
Object |
clone() Создаёт и возвращает новый ModelMBeanAttributeInfo, который является дубликатом этого ModelMBeanAttributeInfo. |
Descriptor |
getDescriptor() Получает копию связанного описателя для ModelMBeanAttributeInfo. |
void |
setDescriptor(Descriptor inDescriptor) Устанавливает связанный описатель (полная замена) для ModelMBeanAttributeDescriptor. |
String |
toString() Возвращает удобочитаемый вариант экземпляра ModelMBeanAttributeInfo. |
Методы, унаследованные от класса javax.management.MBeanAttributeInfo
equals, getType, hashCode, isIs, isReadable, isWritable Методы, унаследованные от класса javax.management.MBeanFeatureInfo
getDescription, getName Методы, унаследованные от класса java.lang.Object
finalize, getClass, 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. Дескриптор недействителен, или поле дескриптора "name" не равно параметру name, или поле дескриптора "descriptorType" не равно "attribute".
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- для незаконного значения для поля Имена или поля Значения. Если построение дескриптора завершится неудачно по какой-либо причине, будет выброшено это исключение. - См. также:
Cloneable
toString
public String toString()
Возвращает удобочитаемую версию экземпляра ModelMBeanAttributeInfo.
- Переопределяет:
-
toStringв классеMBeanAttributeInfo - Возвращает:
- строковое представление объекта.
© 1993, 2020, 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.