Spec-Zone.ru › OpenJDK 21

Класс 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, содержимое которого является объединением заданных дескрипторов.

Методы, объявленные в классе java.lang.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)

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

Параметры:
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 - если два дескриптора содержат одно и то же имя поля с разными соответствующими значениями. Массивы примитивных типов считаются одинаковыми, если они одного типа с одними и теми же элементами. Массивы объектов считаются одинаковыми, если 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
Возвращает:
Массив строк полей в формате имяПоля=значениеПоля
Если значение поля не является строкой, то для него вызывается метод toString(), и возвращаемое значение, заключенное в скобки, используется в качестве значения поля в возвращаемом массиве. Если значение поля равно null, то значение поля в возвращаемом массиве будет пустым. Если дескриптор пустой, вы получите пустой массив.
См. также:
  • Descriptor.setFields(java.lang.String[], java.lang.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)
Сравнивает этот дескриптор с заданным объектом. Объекты равны, если заданный объект также является дескриптором, и если два дескриптора имеют одинаковые имена полей (возможно, различающиеся по регистру) и одинаковые соответствующие значения. Соответствующие значения для поля в двух дескрипторах равны, если выполняются следующие условия:
  • Если одно значение равно 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(java.lang.Object)

isValid

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

clone

public Descriptor clone()

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

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

Specified by:
clone in interface Descriptor
Overrides:
clone in class Object
Returns:
клонированную копию этого экземпляра.
Throws:
RuntimeOperationsException - для некорректного значения для поля Имена или поля Значения. Если создание дескриптора завершается неудачей по любой причине, будет выброшено это исключение.
See Also:
  • Cloneable

setFields

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

setField

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

removeField

public final void removeField(String fieldName)
Удаляет поле из дескриптора.
Specified by:
removeField in interface Descriptor
Parameters:
fieldName - Строковое имя поля, которое нужно удалить. Если имя поля некорректно или поле не найдено, исключение не выбрасывается.
Throws:
RuntimeOperationsException - если поле с данным именем существует, и дескриптор неизменяемый. Обернутое исключение будет UnsupportedOperationException.

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

Spec-Zone.ru

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