Spec-Zone.ru › OpenJDK 25

Класс ImmutableDescriptor

java.lang.Object
javax.management.ImmutableDescriptor
Все реализуемые интерфейсы:
Serializable, Cloneable, Descriptor
public class ImmutableDescriptor extends Object implements Descriptor
Неизменяемый дескриптор.
С версии:
1.6
См. также:
  • Сериализованная форма

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

Модификатор и тип Поле Описание
static final ImmutableDescriptor EMPTY_DESCRIPTOR
Пустой дескриптор.

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

Конструктор Описание
ImmutableDescriptor(String... fields)
Создает дескриптор, содержащий указанные поля.
ImmutableDescriptor(String[] fieldNames, Object[] fieldValues)
Создает дескриптор, содержащий указанные поля и значения.
ImmutableDescriptor(Map<String,?> fields)
Создает дескриптор, в котором именами и значениями полей являются ключи и значения указанной Map.

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

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

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

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

Подробное описание полей

EMPTY_DESCRIPTOR

public static final ImmutableDescriptor EMPTY_DESCRIPTOR
Пустой дескриптор.

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

ImmutableDescriptor

public ImmutableDescriptor(String[] fieldNames, Object[] fieldValues)
Создает дескриптор, содержащий указанные поля и значения.
Параметры:
fieldNames — имена полей
fieldValues — значения полей
Исключения:
IllegalArgumentException — если один из массивов равен null, массивы имеют разные размеры, имя поля равно null или пусто либо одно и то же имя поля указано более одного раза.

ImmutableDescriptor

public ImmutableDescriptor(String... fields)
Создает дескриптор, содержащий указанные поля. Каждая строка должна иметь вид fieldName=fieldValue. Имя поля заканчивается на первом символе =; например, если строка равна a=b=c, то имя поля — a, а его значение — b=c.
Параметры:
fields — имена полей
Исключения:
IllegalArgumentException — если параметр равен null, имя поля пусто, одно и то же имя поля указано более одного раза или одна из строк не содержит символ =.

ImmutableDescriptor

public ImmutableDescriptor(Map<String,?> fields)

Создает дескриптор, в котором именами и значениями полей являются ключи и значения указанной Map.

Параметры:
fields — имена и значения полей
Исключения:
IllegalArgumentException — если параметр равен null, имя поля равно null или пусто либо одно и то же имя поля указано более одного раза (это возможно, поскольку регистр символов в именах полей не учитывается).

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

union

public static ImmutableDescriptor union(Descriptor... descriptors)

Возвращает ImmutableDescriptor, содержимое которого представляет собой объединение указанных дескрипторов. Каждое имя поля, встречающееся в любом из дескрипторов, будет присутствовать в результате со значением, которое оно имеет на момент вызова метода. Последующие изменения любого из дескрипторов не влияют на возвращаемый здесь ImmutableDescriptor.

В простейшем случае имеется только один дескриптор, и возвращаемый ImmutableDescriptor является копией его полей на момент вызова этого метода:

Descriptor d = something();
ImmutableDescriptor copy = ImmutableDescriptor.union(d);
Параметры:
descriptors — дескрипторы для объединения. Любой из дескрипторов может быть равен null; в этом случае он пропускается.
Возвращает:
ImmutableDescriptor, представляющий собой объединение указанных дескрипторов. Возвращаемый объект может совпадать с одним из входных дескрипторов, если он является ImmutableDescriptor, содержащим все необходимые поля.
Исключения:
IllegalArgumentException — если два Descriptor содержат одно и то же имя поля с разными соответствующими значениями. Значения примитивных массивов считаются одинаковыми, если они имеют одинаковый тип и одинаковые элементы. Значения массивов объектов считаются одинаковыми, если Arrays.deepEquals(Object[],Object[]) возвращает true.

getFieldValue

public final Object getFieldValue(String fieldName)
Описание скопировано из интерфейса: Descriptor
Возвращает значение для указанного имени поля или null, если для этого имени значение отсутствует.
Определен в:
getFieldValue в интерфейсе Descriptor
Параметры:
fieldName — имя поля.
Возвращает:
соответствующее значение или null, если поле отсутствует.

getFields

public final String[] getFields()
Описание скопировано из интерфейса: Descriptor
Возвращает все поля, содержащиеся в этом дескрипторе, в виде массива строк.
Определен в:
getFields в интерфейсе Descriptor
Возвращает:
Массив строк с полями в формате fieldName=fieldValue
Если значение поля не является строкой, для него вызывается метод toString(), а возвращенное значение, заключенное в круглые скобки, используется как значение поля в возвращаемом массиве. Если значение поля равно null, значение поля в возвращаемом массиве будет пустым. Если дескриптор пуст, будет возвращен пустой массив.
См. также:
  • Descriptor.setFields(String[], Object[])

getFieldValues

public final Object[] getFieldValues(String... fieldNames)
Описание скопировано из интерфейса: Descriptor
Возвращает все значения полей в дескрипторе в виде массива объектов. Возвращаемые значения расположены в том же порядке, что и в параметре — массиве строк fieldNames.
Определен в:
getFieldValues в интерфейсе Descriptor
Параметры:
fieldNames — массив строк с именами полей, значения которых следует вернуть. Если массив пуст, будет возвращен пустой массив. Если массив равен null, будут возвращены все значения, как если бы параметром был массив, возвращаемый методом Descriptor.getFieldNames(). Если указанного в массиве имени поля не существует, в том числе если оно равно null или пустой строке, для соответствующего элемента возвращаемого массива будет возвращено null.
Возвращает:
Массив объектов со значениями полей. Если список fieldNames пуст, будет возвращен пустой массив.

getFieldNames

public final String[] getFieldNames()
Описание скопировано из интерфейса: Descriptor
Возвращает все имена полей в дескрипторе.
Определен в:
getFieldNames в интерфейсе Descriptor
Возвращает:
Массив строк с именами полей. Если дескриптор пуст, будет возвращен пустой массив.

equals

public boolean equals(Object o)
Сравнивает этот дескриптор с указанным объектом. Объекты равны, если указанный объект также является Descriptor, а оба Descriptor имеют одинаковые имена полей (регистр символов может различаться) и одинаковые соответствующие значения. Соответствующие значения поля в двух Descriptor равны, если выполняются следующие условия:
  • Если одно значение равно null, то и другое должно быть равно null.
  • Если одно значение является примитивным массивом, то другое должно быть примитивным массивом того же типа с теми же элементами.
  • Если одно значение является массивом объектов, то другое также должно быть массивом объектов, а Arrays.deepEquals(Object[],Object[]) должен возвращать true.
  • В противном случае Object.equals(Object) должен возвращать true.
Определен в:
equals в интерфейсе Descriptor
Переопределяет:
equals в классе Object
Параметры:
o — объект для сравнения.
Возвращает:
true, если объекты равны; false в противном случае.
См. также:
  • Object.hashCode()
  • HashMap

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(Object[]).
  • В противном случае h равно v.hashCode().
Определен в:
hashCode в интерфейсе Descriptor
Переопределяет:
hashCode в классе Object
Возвращает:
Значение хеш-кода этого объекта.
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(Object)

isValid

public boolean isValid()
Возвращает true, если все поля имеют допустимые значения с учетом их имен. Этот метод всегда возвращает true, однако подкласс может переопределить его так, чтобы при необходимости он возвращал false.
Определен в:
isValid в интерфейсе Descriptor
Возвращает:
true, если значения допустимы.
Исключения:
RuntimeOperationsException — если проверка допустимости завершилась с ошибкой. Метод возвращает false, если дескриптор недопустим, но выбрасывает это исключение, если попытка определить допустимость завершается неудачей.

clone

public Descriptor clone()

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

Этот метод возвращает объект, для которого он был вызван. Подкласс может переопределить его и возвращать другой объект, если при этом соблюдаются требования контракта.

Определен в:
clone в интерфейсе Descriptor
Переопределяет:
clone в классе Object
Возвращает:
Дескриптор, равный этому дескриптору.
Исключения:
RuntimeOperationsException — при недопустимом значении для имен полей или значений полей. Если создание дескриптора завершается неудачей по какой-либо причине, будет выброшено это исключение.
См. также:
  • Cloneable

setFields

public final void setFields(String[] fieldNames, Object[] fieldValues) throws RuntimeOperationsException
Эта операция не поддерживается, поскольку данный класс является неизменяемым. Если бы этот вызов изменил изменяемый дескриптор с таким же содержимым, будет выброшено исключение RuntimeOperationsException, обертывающее UnsupportedOperationException. В противном случае поведение будет таким же, как и для изменяемого дескриптора: либо выбрасывается исключение из-за недопустимых параметров, либо операция не оказывает эффекта.
Определен в:
setFields в интерфейсе Descriptor
Параметры:
fieldNames — массив строк с именами полей. Массив и его элементы не могут быть равны null.
fieldValues — массив объектов с соответствующими значениями полей. Массив не может быть равен null. Элементы массива могут быть равны null.
Исключения:
RuntimeOperationsException — если изменение не удается по какой-либо причине. Обернутое исключение — IllegalArgumentException, если fieldNames или fieldValues равно null, массивы имеют разную длину или один из них содержит недопустимое значение. Обернутое исключение — UnsupportedOperationException, если дескриптор неизменяемый, а вызов изменил бы его содержимое.
См. также:
  • Descriptor.getFields()

setField

public final void setField(String fieldName, Object fieldValue) throws RuntimeOperationsException
Эта операция не поддерживается, поскольку данный класс является неизменяемым. Если бы этот вызов изменил изменяемый дескриптор с таким же содержимым, будет выброшено исключение RuntimeOperationsException, обертывающее UnsupportedOperationException. В противном случае поведение будет таким же, как и для изменяемого дескриптора: либо выбрасывается исключение из-за недопустимых параметров, либо операция не оказывает эффекта.
Определен в:
setField в интерфейсе Descriptor
Параметры:
fieldName — имя устанавливаемого поля. Не может быть равно null или пустой строке.
fieldValue — значение, устанавливаемое для указанного имени поля. Может быть равно null, если это допустимое значение для данного поля.
Исключения:
RuntimeOperationsException — если имя поля или значение поля недопустимо (обернутое исключение — IllegalArgumentException); или если дескриптор неизменяемый (обернутое исключение — UnsupportedOperationException).

removeField

public final void removeField(String fieldName)
Удаляет поле из дескриптора.
Определен в:
removeField в интерфейсе Descriptor
Параметры:
fieldName — строковое имя удаляемого поля. Если имя поля недопустимо или поле не найдено, исключение не выбрасывается.
Исключения:
RuntimeOperationsException — если поле с указанным именем существует, а дескриптор неизменяемый. Обернутое исключение будет иметь тип UnsupportedOperationException.

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по 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/ImmutableDescriptor.html

Spec-Zone.ru

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