Spec-Zone.ru › OpenJDK 17

Класс CompositeType

java.lang.Object
javax.management.openmbean.OpenType<CompositeData>
javax.management.openmbean.CompositeType
Все реализуемые интерфейсы:
Serializable
public class CompositeType extends OpenType<CompositeData>
Класс CompositeType — это класс открытого типа, экземпляры которого описывают типы значений CompositeData.
С тех пор:
1.5
См. также:
  • Сериализованная форма

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

Поля, объявленные в классе javax.management.openmbean.OpenType

ALLOWED_CLASSNAMES, ALLOWED_CLASSNAMES_LIST

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

Конструктор Описание
CompositeType(String typeName, String description, String[] itemNames, String[] itemDescriptions, OpenType<?>[] itemTypes)
Создаёт экземпляр CompositeType, проверяя на корректность переданные параметры.

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

Модификатор и тип Метод Описание
boolean containsKey(String itemName)
Возвращает true, если этот экземпляр CompositeType определяет элемент с именем itemName.
boolean equals(Object obj)
Сравнивает переданный obj параметр с этим экземпляром CompositeType на равенство.
String getDescription(String itemName)
Возвращает описание элемента с именем itemName, или null если этот экземпляр CompositeType не определяет никакого элемента с именем itemName.
OpenType<?> getType(String itemName)
Возвращает открытый тип элемента с именем itemName, или null если этот экземпляр CompositeType не определяет никакого элемента с именем itemName.
int hashCode()
Возвращает хэш-код для этого экземпляра CompositeType.
boolean isValue(Object obj)
Проверяет, является ли obj значением, которое может быть описано этим экземпляром CompositeType.
Set<String> keySet()
Возвращает немодифицируемый вид Set всех имён элементов, определённых этим экземпляром CompositeType.
String toString()
Возвращает строковое представление этого экземпляра CompositeType.

Методы, объявленные в классе javax.management.openmbean.OpenType

getClassName, getDescription, getTypeName, isArray

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

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

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

CompositeType

public CompositeType(String typeName, String description, String[] itemNames, String[] itemDescriptions, OpenType<?>[] itemTypes) throws OpenDataException
Создаёт экземпляр CompositeType, проверяя корректность заданных параметров. Ограничения корректности для каждого параметра описаны ниже.

Обратите внимание, что содержимое трёх массивов параметров itemNames, itemDescriptions и itemTypes копируется во внутреннем представлении, таким образом, любые последующие изменения этих массивов вызывающей стороной этого конструктора не повлияют на созданный экземпляр CompositeType.

Имя класса Java для значений составных данных, представленных этим типом (т.е. имя класса, возвращаемое методом getClassName), устанавливается в строковое значение, возвращаемое CompositeData.class.getName().

Параметры:
typeName - Имя, присвоенное типу составных данных, представленному этим экземпляром; не может быть null или пустой строкой.
description - Читабельное описание типа составных данных, представленного этим экземпляром; не может быть null или пустой строкой.
itemNames - Имена элементов, содержащихся в значениях составных данных, описанных этим экземпляром CompositeType; не может быть null и должно содержать как минимум один элемент; ни один элемент не может быть null или пустой строкой. Обратите внимание, что порядок, в котором указаны имена элементов, не важен для различения одного экземпляра CompositeType от другого; имена элементов сохраняются во внутреннем представлении, отсортированными по возрастанию в алфавитном порядке.
itemDescriptions - Описания элементов, в том же порядке, что и itemNames, содержащихся в значениях составных данных, описанных этим экземпляром CompositeType ; размер должен быть таким же, как у itemNames; ни один элемент не может быть null или пустой строкой.
itemTypes - Экземпляры открытых типов, в том же порядке, что и itemNames, описывающие элементы, содержащиеся в значениях составных данных, описанных этим экземпляром CompositeType ; размер должен быть таким же, как у itemNames; ни один элемент не может быть null.
Исключение:
IllegalArgumentException - Если typeName или description являются null или пустой строкой, или itemNames или itemDescriptions или itemTypes являются null, или любой элемент itemNames или itemDescriptions является null или пустой строкой, или любой элемент itemTypes является null, или itemNames или itemDescriptions или itemTypes не имеют одинаковый размер.
OpenDataException - Если itemNames содержит дубликаты имён элементов (чувствительно к регистру, но с удалёнными начальными и конечными пробелами).

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

containsKey

public boolean containsKey(String itemName)
Возвращает true, если этот экземпляр CompositeType определяет элемент с именем itemName.
Параметры:
itemName - имя элемента.
Возвращает:
true, если элемент с таким именем присутствует.

getDescription

public String getDescription(String itemName)
Возвращает описание элемента с именем itemName, или null, если этот экземпляр CompositeType не определяет элемент с именем itemName.
Параметры:
itemName - имя элемента.
Возвращает:
описание.

getType

public OpenType<?> getType(String itemName)
Возвращает открытый тип элемента с именем itemName, или null, если этот экземпляр CompositeType не определяет элемент с именем itemName.
Параметры:
itemName - имя элемента.
Возвращает:
тип.

keySet

public Set<String> keySet()
Возвращает неизменяемый вид множества всех имён элементов, определённых этим экземпляром CompositeType. Итератор множества вернёт имена элементов в порядке возрастания.
Возвращает:
множество Set имён String.

isValue

public boolean isValue(Object obj)
Проверяет, является ли obj значением, которое можно описать с помощью этого экземпляра CompositeType.

Если obj равно null или не является экземпляром javax.management.openmbean.CompositeData, isValue возвращает false.

Если obj является экземпляром javax.management.openmbean.CompositeData, то пусть ct будет его типом CompositeType, возвращённым методом CompositeData.getCompositeType(). Результат равен true, если this совместим с ct. Это означает, что:

  • this.getTypeName() равен ct.getTypeName(), и
  • нет имён элементов, присутствующих в this, которых нет в ct, и
  • для каждого элемента в this, его тип совместим с типом соответствующего элемента в ct.

Один тип TabularType совместим с другим TabularType , если у них одинаковые typeName и список имён индексов, а тип строки первого совместим с типом строки второго.

Один тип ArrayType совместим с другим ArrayType , если у них одинаковая размерность; оба являются примитивными массивами или ни один из них не является; и тип элемента первого совместим с типом элемента второго.

Во всех остальных случаях, один тип OpenType совместим с другим OpenType только если они равны.

Эти правила означают, что дополнительные элементы могут быть добавлены в CompositeData без того, чтобы это делало его недействительным для CompositeType , у которого этих элементов нет.

Определено в:
isValue в классе OpenType<CompositeData>
Параметры:
obj - значение, тип которого необходимо проверить на совместимость с этим экземпляром CompositeType .
Возвращает:
true , если obj является значением для этого типа составных данных, false в противном случае.

equals

public boolean equals(Object obj)
Сравнивает указанный параметр obj с этим экземпляром CompositeType на равенство.

Два экземпляра CompositeType равны тогда и только тогда, когда истинны все следующие утверждения:

  • их имена типов равны
  • имена и типы их элементов равны
Определено в:
equals в классе OpenType<CompositeData>
Параметры:
obj - объект для сравнения на равенство с этим экземпляром CompositeType ; если obj является null, equals возвращает false.
Возвращает:
true , если указанный объект равен этому экземпляру CompositeType .
См. также:
  • Object.hashCode()
  • HashMap

hashCode

public int hashCode()
Возвращает хэш-код для этого экземпляра CompositeType .

Хэш-код экземпляра CompositeType — это сумма хэш-кодов всех элементов информации, используемых в сравнениях equals (т. е.: имя, имена элементов, типы элементов). Это гарантирует, что t1.equals(t2) подразумевает, что t1.hashCode()==t2.hashCode() для любых двух экземпляров CompositeType t1 и t2, как требуется общим соглашением метода Object.hashCode().

Поскольку экземпляры CompositeType неизменяемы, хэш-код для этого экземпляра вычисляется один раз при первом вызове hashCode, а затем то же значение возвращается для последующих вызовов.

Переопределяет:
hashCode в классе Object
Возвращает:
значение хэш-кода для этого экземпляра CompositeType
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

toString

public String toString()
Возвращает строковое представление этого экземпляра CompositeType .

Строковое представление состоит из имени этого класса (т.е. javax.management.openmbean.CompositeType), имени типа для этого экземпляра и списка имён и типов элементов — строкового представления этого экземпляра.

Поскольку экземпляры CompositeType неизменяемы, строковое представление для этого экземпляра вычисляется один раз при первом вызове toString, а затем то же значение возвращается для последующих вызовов.

Определено в:
toString в классе OpenType<CompositeData>
Возвращает:
строковое представление этого экземпляра CompositeType

© 1993, 2021, 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/17/docs/api/java.management/javax/management/openmbean/CompositeType.html

Spec-Zone.ru

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