Класс DescriptorSupport

java.lang.Object

javax.management.modelmbean.DescriptorSupport

Все реализованные интерфейсы:: Serializable, Cloneable, Descriptor

public class DescriptorSupport extends Object implements Descriptor

Этот класс представляет набор метаданных для элемента ModelMBean. Дескриптор является частью ModelMBeanInfo, ModelMBeanNotificationInfo, ModelMBeanAttributeInfo, ModelMBeanConstructorInfo и ModelMBeanParameterInfo.

Дескриптор состоит из набора полей. Каждое поле имеет формат fieldName=fieldValue. Имена полей нечувствительны к регистру, регистр значений полей сохраняется.

Все имена и значения полей не предопределены. Новые поля могут быть определены и добавлены любой программой. Некоторые поля были предопределены для обеспечения согласованности реализации и поддержки ModelMBeanInfo, ModelMBeanAttributeInfo, ModelMBeanConstructorInfo, ModelMBeanNotificationInfo, ModelMBeanOperationInfo и классов ModelMBean.

serialVersionUID этого класса равен -6292969195866300415L.

С:

1.5

См. также:

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

Конструктор	Описание
`DescriptorSupport()`	Конструктор по умолчанию для дескриптора.
`DescriptorSupport(int initNumFields)`	Конструктор дескриптора.
`DescriptorSupport(String inStr)`	Конструктор дескриптора, принимающий строку XML.
`DescriptorSupport(String... fields)`	Конструктор, принимающий поля в формате имяПоля=значениеПоля.
`DescriptorSupport(String[] fieldNames, Object[] fieldValues)`	Конструктор, принимающий имена полей и значения полей.
`DescriptorSupport(DescriptorSupport inDescr)`	Конструктор дескриптора, принимающий дескриптор в качестве параметра.

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

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Возвращает новый дескриптор, являющийся дубликатом дескриптора.
`boolean`	`equals(Object o)`	Сравнивает этот дескриптор с заданным объектом.
`String[]`	`getFieldNames()`	Возвращает все имена полей в дескрипторе.
`String[]`	`getFields()`	Возвращает все поля, содержащиеся в этом дескрипторе, в виде массива строк.
`Object`	`getFieldValue(String fieldName)`	Возвращает значение для определенного имени поля или null, если для этого имени значения нет.
`Object[]`	`getFieldValues(String... fieldNames)`	Возвращает все значения полей в дескрипторе в виде массива объектов.
`int`	`hashCode()`	Возвращает хэш-код для этого дескриптора.
`boolean`	`isValid()`	Возвращает true, если все поля имеют допустимые значения, учитывая их имена.
`void`	`removeField(String fieldName)`	Удаляет поле из дескриптора.
`void`	`setField(String fieldName, Object fieldValue)`	Устанавливает значение для определенного имени поля.
`void`	`setFields(String[] fieldNames, Object[] fieldValues)`	Устанавливает все поля в массиве имен полей в новое значение с тем же индексом в массиве значений полей.
`String`	`toString()`	Возвращает удобочитаемую строку, представляющую дескриптор.
`String`	`toXMLString()`	Возвращает строку XML, представляющую дескриптор.

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

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

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

DescriptorSupport

public DescriptorSupport()

Конструктор по умолчанию для описателя. Размер начального описателя по умолчанию равен 20. Он будет увеличиваться по мере необходимости.
Обратите внимание, что созданный пустой описатель не является допустимым описателем (метод isValid возвращает false)

DescriptorSupport

public DescriptorSupport(int initNumFields) throws MBeanException, RuntimeOperationsException

Конструктор описателя. Принимает в качестве параметра начальную емкость Map, хранящей поля описателя. Емкость будет увеличиваться по мере необходимости.
Обратите внимание, что созданный пустой описатель не является допустимым описателем (метод isValid возвращает false).

Parameters:: initNumFields - Начальная емкость Map, хранящей поля описателя.
Throws:: RuntimeOperationsException - для недопустимого значения для initNumFields (<= 0); MBeanException - Оборачивает исключение распределенной коммуникации.

DescriptorSupport

public DescriptorSupport(DescriptorSupport inDescr)

Конструктор описателя, принимающий описатель в качестве параметра. Создает новый описатель, инициализированный значениями описателя, переданного в качестве параметра.

Parameters:: inDescr - описатель, используемый для инициализации созданного описателя. Если он равен null или не содержит полей описателя, будет создан пустой описатель.

DescriptorSupport

public DescriptorSupport(String inStr) throws MBeanException, RuntimeOperationsException, XMLParseException

Конструктор описателя, принимающий XML-строку.

Формат XML-строки не определен, но реализация должна гарантировать, что строка, возвращаемая методом toXMLString() для существующего описателя, может быть использована для создания эквивалентного описателя с помощью этого конструктора.

В этой реализации все значения полей будут созданы как строки. Если значения полей не являются строками, программист должен правильно переустановить или преобразовать эти поля.

Parameters:: inStr - XML-строка в формате, используемая для заполнения этого описателя. Формат не определен, но любая реализация должна гарантировать, что строка, возвращаемая методом toXMLString для существующего описателя, может быть использована для создания эквивалентного описателя с помощью этого конструктора.
Throws:: RuntimeOperationsException - Если строка inStr, переданная в качестве параметра, равна null; XMLParseException - Проблема с разбором XML при разборе входной строки; MBeanException - Оборачивает исключение распределенной коммуникации.

DescriptorSupport

public DescriptorSupport(String[] fieldNames, Object[] fieldValues) throws RuntimeOperationsException

Конструктор, принимающий имена полей и значения полей. Ни один из массивов не может быть null.

Parameters:: fieldNames - Массив строк имён полей. Ни один элемент этого массива не может быть null.; fieldValues - Массив объектов соответствующих значений полей. Элементы массива могут быть null. Значения fieldValue должны быть валидными для fieldName (как определено в методе isValid)
Примечание: размеры массивов параметров должны совпадать. Если оба массива пусты, то создаётся пустой описатель.
Throws:: RuntimeOperationsException - для недопустимого значения для имён полей или значений полей. Длины массивов должны быть равны. Если создание описателя по какой-либо причине завершается неудачей, это исключение будет выброшено.

DescriptorSupport

public DescriptorSupport(String... fields)

Конструктор, принимающий поля в формате fieldName=fieldValue.

Parameters:

fields - Массив строк, где каждый элемент содержит имя и значение поля. Если этот массив null или пуст, выполняется конструктор по умолчанию. Нулевые строки или пустые строки будут игнорироваться.

Все значения полей должны быть строками. Если значения полей не являются строками, программист должен правильно переустановить или преобразовать эти поля.

Примечание: каждая строка должна иметь вид fieldName=fieldValue. Имя поля заканчивается на первом символе =; например, если строка a=b=c, то имя поля a, а его значение b=c.

Throws:

RuntimeOperationsException - для недопустимого значения для имён полей или значений полей. Поле должно содержать символ «=». "=fieldValue", "fieldName" и "fieldValue" являются недопустимыми. Имя поля не может быть null. "fieldName=" приведет к значению null. Если создание описателя по какой-либо причине завершится неудачей, будет выброшено это исключение.

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

getFieldValue

public Object getFieldValue(String fieldName) throws RuntimeOperationsException

Описание скопировано из интерфейса: Descriptor

Возвращает значение для определённого имени поля или null, если для этого имени значение отсутствует.

Specified by:: getFieldValue в интерфейсе Descriptor
Parameters:: fieldName - имя поля.
Returns:: соответствующее значение или null, если поле отсутствует.
Throws:: RuntimeOperationsException - если имя поля недопустимо.

setField

public void setField(String fieldName, Object fieldValue) throws RuntimeOperationsException

Описание скопировано из интерфейса: Descriptor

Устанавливает значение для определённого имени поля. Это изменит существующее поле или добавит новое.

Значение поля будет проверено перед установкой. Если оно не является допустимым, будет выброшено исключение. Смысл валидности зависит от реализации описателя.

Specified by:: setField в интерфейсе Descriptor
Parameters:: fieldName - Имя поля, которое нужно установить. Не может быть null или пустым.; fieldValue - Значение поля, которое нужно установить для имени поля. Может быть null, если это допустимое значение для поля.
Throws:: RuntimeOperationsException - если имя поля или значение поля недопустимы (оборачиваемое исключение IllegalArgumentException); или если описатель неизменяем (оборачиваемое исключение UnsupportedOperationException).

getFields

public String[] getFields()

Описание скопировано из интерфейса: Descriptor

Возвращает все поля, содержащиеся в этом описателе, в виде массива строк.

Specified by:

getFields в интерфейсе Descriptor

Returns:

Массив строк полей в формате fieldName=fieldValue
Если значение поля не является строкой, то вызывается метод toString() для него, и возвращаемое значение, заключенное в скобки, используется в качестве значения поля в возвращаемом массиве. Если значение поля равно null, то значение поля в возвращаемом массиве будет пустым. Если описатель пуст, вы получите пустой массив.

See Also:

getFieldNames

public String[] getFieldNames()

Описание скопировано из интерфейса: Descriptor

Возвращает все имена полей в описателе.

Specified by:: getFieldNames в интерфейсе Descriptor
Returns:: Массив строк имён полей. Если описатель пуст, вы получите пустой массив.

getFieldValues

public Object[] getFieldValues(String... fieldNames)

Описание скопировано из интерфейса: Descriptor

Возвращает все значения полей в описателе в виде массива объектов. Возвращаемые значения расположены в том же порядке, что и fieldNames массив строк параметров.

Specified by:: getFieldValues в интерфейсе Descriptor
Parameters:: fieldNames - Массив строк имён полей, для которых должны быть возвращены значения. Если массив пуст, возвращается пустой массив. Если массив равен null, возвращаются все значения, как если бы параметром был массив, возвращаемый методом Descriptor.getFieldNames(). Если имя поля в массиве не существует, включая случай, когда оно равно null или пустой строке, для соответствующего элемента возвращаемого массива возвращается null.
Returns:: Массив объектов значений полей. Если список fieldNames пуст, вы получите пустой массив.

setFields

public void setFields(String[] fieldNames, Object[] fieldValues) throws RuntimeOperationsException

Описание скопировано из интерфейса: Descriptor

Устанавливает все поля в массиве имён полей новым значениям с тем же индексом в массиве значений полей. Размеры массивов должны совпадать.

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

Specified by:

setFields в интерфейсе Descriptor

Parameters:

fieldNames - Массив имён полей. Массив и элементы массива не могут быть null.

fieldValues - Массив соответствующих значений полей. Массив не может быть null. Элементы массива могут быть null.

Throws:

RuntimeOperationsException - если изменение не удалось по какой-либо причине. Оборачиваемое исключение - IllegalArgumentException, если fieldNames или fieldValues равно null, или если массивы имеют различную длину, или если в одном из них есть недопустимое значение. Оборачиваемое исключение - UnsupportedOperationException, если дескриптор неизменяемый, и вызов изменит его содержимое.

See Also:

clone

public Object clone() throws RuntimeOperationsException

Возвращает новый дескриптор, являющийся дубликатом дескриптора.

Specified by:

clone в интерфейсе Descriptor

Overrides:

clone в классе Object

Returns:

клонированный экземпляр.

Throws:

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

See Also:

removeField

public void removeField(String fieldName)

Описание скопировано из интерфейса: Descriptor

Удаляет поле из дескриптора.

Specified by:: removeField в интерфейсе Descriptor
Parameters:: fieldName - Строковое имя поля, подлежащего удалению. Если имя поля некорректно или поле не найдено, исключение не выбрасывается.

equals

public boolean equals(Object o)

Сравнивает этот дескриптор с данным объектом. Объекты равны, если данный объект также является дескриптором, и если два дескриптора имеют одинаковые имена полей (возможно, отличающиеся регистром) и те же связанные значения. Соответствующие значения для поля в двух дескрипторах равны, если выполняются следующие условия:

Если одно значение равно null, то другое также должно быть null.
Если одно значение является примитивным массивом, то другое должно быть примитивным массивом того же типа с теми же элементами.
Если одно значение является массивом объектов, то другое также должно быть массивом объектов и Arrays.deepEquals должен возвращать true.
В противном случае Object.equals(Object) должен возвращать true.

Specified by:

equals в интерфейсе Descriptor

Overrides:

equals в классе Object

Parameters:

o - объект для сравнения.

Returns:

true если объекты одинаковы; false в противном случае.

See Also:

hashCode

public int hashCode()

Возвращает значение хэш-кода для этого дескриптора. Хэш-код вычисляется как сумма хэш-кодов каждого поля в дескрипторе. Хэш-код поля с именем n и значением v равен n.toLowerCase().hashCode() ^ h. Здесь h - хэш-код v, вычисляемый следующим образом:

Если v равно null, то h равно 0.
Если v является примитивным массивом, то h вычисляется с помощью соответствующей перегрузки java.util.Arrays.hashCode.
Если v является массивом объектов, то h вычисляется с помощью Arrays.deepHashCode.
В противном случае h равен v.hashCode().

Specified by:

hashCode в интерфейсе Descriptor

Overrides:

hashCode в классе Object

Returns:

Значение хэш-кода для этого объекта.

See Also:

isValid

public boolean isValid() throws RuntimeOperationsException

Возвращает true, если все поля имеют законные значения, учитывая их имена.

Эта реализация не поддерживает взаимодействие с каталогом или службой поиска. Таким образом, в соответствии со спецификацией, проверка не выполняется для поля "export".

В противном случае эта реализация возвращает false, если:

Поля name и descriptorType fieldNames не определены, или null, или пусты, или не являются строками.
Поля class, role, getMethod, setMethod fieldNames, если определены, равны null или не являются строками.
Поля persistPeriod, currencyTimeLimit, lastUpdatedTimeStamp, lastReturnedTimeStamp, если определены, равны null, или не являются числовыми строками, или не являются числовыми значениями >= -1.
Поле log fieldName, если определено, равно null, или не является булевым, или не является строкой со значением "t", "f", "true", "false". Эти строковые значения нечувствительны к регистру.
Поле visibility fieldName, если определено, равно null, или не является числовой строкой или не является числовым значением >= 1 и <= 4.
Поле severity fieldName, если определено, равно null, или не является числовой строкой или не является числовым значением >= 0 и <= 6.
Поле persistPolicy fieldName, если определено, равно null, или не является одной из следующих строк: "OnUpdate", "OnTimer", "NoMoreOftenThan", "OnUnregister", "Always", "Never". Эти строковые значения нечувствительны к регистру.

Specified by:: isValid в интерфейсе Descriptor
Returns:: true, если значения законны.
Throws:: RuntimeOperationsException - Если проверка на валидность завершается неудачно по любой причине, это исключение будет выброшено.

toXMLString

public String toXMLString()

Возвращает строку XML, представляющую дескриптор.

Формат не определён, но реализация должна гарантировать, что строка, возвращаемая этим методом, может быть использована для создания эквивалентного дескриптора при создании экземпляра с помощью конструктора DescriptorSupport(String inStr).

Для полей, которые не являются строковыми объектами, вызывается метод toString(), чтобы создать значение. Значение будет заключено в скобки. Не гарантируется, что вы сможете восстановить эти объекты, если они не были специально настроены для поддержки метода toString() в осмысленном формате и имеют соответствующий конструктор, принимающий строку в том же формате.

Если дескриптор пустой, возвращается следующая строка: <Descriptor></Descriptor>

Returns:: строку XML.
Throws:: RuntimeOperationsException - для недопустимого значения для имён полей или значений полей. Если построение строки в формате XML не удалось по какой-либо причине, это исключение будет выброшено.

toString

public String toString()

Возвращает удобочитаемую строку, представляющую дескриптор. Строка будет иметь формат "fieldName=fieldValue,fieldName2=fieldValue2,...". Если в дескрипторе нет полей, возвращается пустая строка. Если fieldValue является объектом, вызывается метод toString() на нём, и возвращаемое им значение используется в качестве значения поля, заключённого в скобки.

Overrides:: toString в классе Object
Returns:: строковое представление объекта.
Throws:: RuntimeOperationsException - для недопустимого значения для имён полей или значений полей. Если формирование строкового представления дескриптора не удалось по какой-либо причине, это исключение будет выброшено.

© 1993, 2023, 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/21/docs/api/java.management/javax/management/modelmbean/DescriptorSupport.html