Spec-Zone.ru › OpenJDK 21

Класс OpenMBeanParameterInfoSupport

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanParameterInfo
javax.management.openmbean.OpenMBeanParameterInfoSupport
Все реализуемые интерфейсы:
Serializable, Cloneable, DescriptorRead, OpenMBeanParameterInfo
public class OpenMBeanParameterInfoSupport extends MBeanParameterInfo implements OpenMBeanParameterInfo
Описание параметра, используемого в одной или нескольких операциях или конструкторах открытого MBean.
С:
1.5
См. также:
  • Сериализованная форма

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

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

description, name

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

Конструктор Описание
OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType)
Создаёт экземпляр OpenMBeanParameterInfoSupport, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, со специфицированными name, openType и description.
OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)
Создаёт экземпляр OpenMBeanParameterInfoSupport , описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, со специфицированными name, openType, description, и descriptor.
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue)
Создаёт экземпляр OpenMBeanParameterInfoSupport , описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, со специфицированными name, openType, description и defaultValue.
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)
Создаёт экземпляр OpenMBeanParameterInfoSupport , описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, со специфицированными name, openType, description, defaultValue, minValue и maxValue.
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues)
Создаёт экземпляр OpenMBeanParameterInfoSupport , описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, со специфицированными name, openType, description, defaultValue и legalValues.

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

Модификатор и тип Метод Описание
boolean equals(Object obj)
Сравнивает указанный параметр obj с этим экземпляром OpenMBeanParameterInfoSupport на равенство.
Object getDefaultValue()
Возвращает значение по умолчанию для параметра, описанного этим экземпляром OpenMBeanParameterInfoSupport , если оно указано, или null в противном случае.
Set<?> getLegalValues()
Возвращает неизменяемый набор допустимых значений для параметра, описанного этим экземпляром OpenMBeanParameterInfoSupport , если он указан, или null в противном случае.
Comparable<?> getMaxValue()
Возвращает максимальное значение для параметра, описанного этим экземпляром OpenMBeanParameterInfoSupport , если оно указано, или null в противном случае.
Comparable<?> getMinValue()
Возвращает минимальное значение для параметра, описанного этим экземпляром OpenMBeanParameterInfoSupport , если оно указано, или null в противном случае.
OpenType<?> getOpenType()
Возвращает открытый тип для значений параметра, описанного этим экземпляром OpenMBeanParameterInfoSupport.
boolean hasDefaultValue()
Возвращает true , если этот экземпляр OpenMBeanParameterInfoSupport задаёт ненулевое значение по умолчанию для описанного параметра, false в противном случае.
int hashCode()
Возвращает хэш-код для этого экземпляра OpenMBeanParameterInfoSupport.
boolean hasLegalValues()
Возвращает true , если этот экземпляр OpenMBeanParameterInfoSupport задаёт ненулевой набор допустимых значений для описанного параметра, false в противном случае.
boolean hasMaxValue()
Возвращает true , если этот экземпляр OpenMBeanParameterInfoSupport задаёт ненулевое максимальное значение для описанного параметра, false в противном случае.
boolean hasMinValue()
Возвращает true , если этот экземпляр OpenMBeanParameterInfoSupport задаёт ненулевое минимальное значение для описанного параметра, false в противном случае.
boolean isValue(Object obj)
Проверяет, является ли obj допустимым значением для параметра, описанного этим экземпляром OpenMBeanParameterInfo.
String toString()
Возвращает строковое представление этого экземпляра OpenMBeanParameterInfoSupport.

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

clone, getType

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

getDescription, getDescriptor, getName

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

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

Методы, объявленные в интерфейсе javax.management.openmbean.OpenMBeanParameterInfo

getDescription, getName

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

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType)
Конструирует экземпляр OpenMBeanParameterInfoSupport, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, с указанными name, openType и description.
Параметры:
name - не может быть пустой или null-строкой.
description - не может быть пустой или null-строкой.
openType - не может быть null.
Исключения:
IllegalArgumentException - если name или description являются пустой или null-строкой, или openType является null.

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)
Конструирует экземпляр OpenMBeanParameterInfoSupport, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, с указанными name, openType, description и descriptor.

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

Параметры:
name - не может быть пустой или null-строкой.
description - не может быть пустой или null-строкой.
openType - не может быть null.
descriptor - Дескриптор для параметра. Может быть null, что эквивалентно пустому дескриптору.
Исключения:
IllegalArgumentException - если name или description являются пустой или null-строкой, или openType является null, или записи дескриптора неверны, как описано в описании пакета.
С версии:
1.6

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue) throws OpenDataException
Конструирует экземпляр OpenMBeanParameterInfoSupport, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, с указанными name, openType, description и defaultValue.
Параметры типа:
T - позволяет компилятору проверить, что defaultValue, если не null, имеет правильный тип Java для данного openType.
Параметры:
name - не может быть пустой или null-строкой.
description - не может быть пустой или null-строкой.
openType - не может быть null.
defaultValue - должно быть допустимым значением для openType, указанного для этого параметра; значение по умолчанию не поддерживается для ArrayType и TabularType; может быть null, в этом случае это означает, что значение по умолчанию не установлено.
Исключения:
IllegalArgumentException - если name или description являются пустой или null-строкой, или openType является null.
OpenDataException - если defaultValue не является допустимым значением для указанного openType, или defaultValue не null и openType является ArrayType или TabularType.

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues) throws OpenDataException

Конструирует экземпляр OpenMBeanParameterInfoSupport, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, с указанными name, openType, description, defaultValue и legalValues.

Содержимое legalValues копируется, поэтому последующие изменения массива, на который ссылается legalValues, не влияют на этот экземпляр OpenMBeanParameterInfoSupport.

Параметры типа:
T - позволяет компилятору проверить, что defaultValue и legalValues, если не null, имеют правильный тип Java для данного openType.
Параметры:
name - не может быть пустой или null-строкой.
description - не может быть пустой или null-строкой.
openType - не может быть null.
defaultValue - должно быть допустимым значением для openType, указанного для этого параметра; значение по умолчанию не поддерживается для ArrayType и TabularType; может быть null, в этом случае это означает, что значение по умолчанию не установлено.
legalValues - каждое содержащееся значение должно быть допустимым для openType, указанного для этого параметра; допустимые значения не поддерживаются для ArrayType и TabularType; может быть null или пустым.
Исключения:
IllegalArgumentException - если name или description являются пустой или null-строкой, или openType является null.
OpenDataException - если defaultValue не является допустимым значением для указанного openType, или одно значение в legalValues не является допустимым для указанного openType, или defaultValue не null и openType является ArrayType или TabularType, или legalValues не null и не пусто, и openType является ArrayType или TabularType, или legalValues не null и не пусто, и defaultValue не содержится в legalValues.

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue) throws OpenDataException
Конструирует экземпляр OpenMBeanParameterInfoSupport, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, с указанными name, openType, description, defaultValue, minValue и maxValue. Можно указать минимальные и максимальные значения только для открытого типа, значения которого являются Comparable.
Параметры типа:
T - позволяет компилятору проверить, что defaultValue, minValue и maxValue, если не null, имеют правильный тип Java для данного openType.
Параметры:
name - не может быть пустой или null-строкой.
description - не может быть пустой или null-строкой.
openType - не может быть null.
defaultValue - должно быть допустимым значением для openType, указанного для этого параметра; значение по умолчанию не поддерживается для ArrayType и TabularType; может быть null, в этом случае это означает, что значение по умолчанию не установлено.
minValue - должно быть допустимым для openType, указанного для этого параметра; может быть null, в этом случае это означает, что минимальное значение не установлено.
maxValue - должно быть допустимым для openType, указанного для этого параметра; может быть null, в этом случае это означает, что максимальное значение не установлено.
Исключения:
IllegalArgumentException - если name или description являются пустой или null-строкой, или openType является null.
OpenDataException - если defaultValue, minValue или maxValue не является допустимым значением для указанного openType, или defaultValue не null и openType является ArrayType или TabularType, или и minValue и maxValue не null и minValue.compareTo(maxValue) > 0 является true, или и defaultValue и minValue не null и minValue.compareTo(defaultValue) > 0 является true, или и defaultValue и maxValue не null и defaultValue.compareTo(maxValue) > 0 является true.

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

getOpenType

public OpenType<?> getOpenType()
Возвращает открытый тип для значений параметра, описываемого этим экземпляром OpenMBeanParameterInfoSupport.
Указано в:
getOpenType в интерфейсе OpenMBeanParameterInfo
Возвращает:
открытый тип.

getDefaultValue

public Object getDefaultValue()
Возвращает значение по умолчанию для параметра, описываемого этим экземпляром OpenMBeanParameterInfoSupport, если указано, или null в противном случае.
Указано в:
getDefaultValue в интерфейсе OpenMBeanParameterInfo
Возвращает:
значение по умолчанию.

getLegalValues

public Set<?> getLegalValues()
Возвращает неизменяемый набор допустимых значений для параметра, описываемого этим экземпляром OpenMBeanParameterInfoSupport, если указано, или null в противном случае.
Указано в:
getLegalValues в интерфейсе OpenMBeanParameterInfo
Возвращает:
множество допустимых значений.

getMinValue

public Comparable<?> getMinValue()
Возвращает минимальное значение для параметра, описываемого этим экземпляром OpenMBeanParameterInfoSupport, если указано, или null в противном случае.
Указано в:
getMinValue в интерфейсе OpenMBeanParameterInfo
Возвращает:
минимальное значение.

getMaxValue

public Comparable<?> getMaxValue()
Возвращает максимальное значение для параметра, описанного этим OpenMBeanParameterInfoSupport экземпляром, если указано, или null в противном случае.
Определяется:
getMaxValue в интерфейсе OpenMBeanParameterInfo
Возвращает:
максимальное значение.

hasDefaultValue

public boolean hasDefaultValue()
Возвращает true , если этот OpenMBeanParameterInfoSupport экземпляр указывает ненулевое значение по умолчанию для описанного параметра, false в противном случае.
Определяется:
hasDefaultValue в интерфейсе OpenMBeanParameterInfo
Возвращает:
true, если значение по умолчанию существует.

hasLegalValues

public boolean hasLegalValues()
Возвращает true , если этот OpenMBeanParameterInfoSupport экземпляр указывает ненулевой набор допустимых значений для описанного параметра, false в противном случае.
Определяется:
hasLegalValues в интерфейсе OpenMBeanParameterInfo
Возвращает:
true, если существует набор допустимых значений.

hasMinValue

public boolean hasMinValue()
Возвращает true , если этот OpenMBeanParameterInfoSupport экземпляр указывает ненулевое минимальное значение для описанного параметра, false в противном случае.
Определяется:
hasMinValue в интерфейсе OpenMBeanParameterInfo
Возвращает:
true, если существует минимальное значение.

hasMaxValue

public boolean hasMaxValue()
Возвращает true , если этот OpenMBeanParameterInfoSupport экземпляр указывает ненулевое максимальное значение для описанного параметра, false в противном случае.
Определяется:
hasMaxValue в интерфейсе OpenMBeanParameterInfo
Возвращает:
true, если существует максимальное значение.

isValue

public boolean isValue(Object obj)
Проверяет, является ли obj допустимым значением для параметра, описанного этим OpenMBeanParameterInfo экземпляром.
Определяется:
isValue в интерфейсе OpenMBeanParameterInfo
Параметры:
obj - проверяемый объект.
Возвращает:
true , если obj является допустимым значением для параметра, описанного этим OpenMBeanParameterInfo экземпляром, false в противном случае.

equals

public boolean equals(Object obj)

Сравнивает указанный obj параметр с этим OpenMBeanParameterInfoSupport экземпляром на равенство.

Возвращает true тогда и только тогда, когда все следующие утверждения истинны:

  • obj не null,
  • obj также реализует интерфейс OpenMBeanParameterInfo,
  • их имена равны
  • их открытые типы равны
  • их значения по умолчанию, мин, макс и допустимые значения равны.
Это гарантирует, что этот equals метод работает корректно для obj параметров, которые являются различными реализациями интерфейса OpenMBeanParameterInfo.

Если obj также реализует DescriptorRead, то его метод getDescriptor() также должен возвращать то же значение, что и для этого объекта.

Определяется:
equals в интерфейсе OpenMBeanParameterInfo
Переопределяет:
equals в классе MBeanParameterInfo
Параметры:
obj - объект для сравнения на равенство с этим OpenMBeanParameterInfoSupport экземпляром.
Возвращает:
true , если указанный объект равен этому OpenMBeanParameterInfoSupport экземпляру.
См. также:
  • Object.hashCode()
  • HashMap

hashCode

public int hashCode()

Возвращает значение хэш-кода для этого OpenMBeanParameterInfoSupport экземпляра.

Хэш-код экземпляра OpenMBeanParameterInfoSupport представляет собой сумму хэш-кодов всех элементов информации, используемых в equals сравнениях (т.е.: его имя, его открытый тип, его значения по умолчанию, мин, макс и допустимые значения, и его дескриптор).

Это гарантирует, что t1.equals(t2) подразумевает, что t1.hashCode()==t2.hashCode() для любых двух OpenMBeanParameterInfoSupport экземпляров t1 и t2, как требуется общим контрактом метода Object.hashCode().

Однако, обратите внимание, что другой экземпляр класса, реализующего интерфейс OpenMBeanParameterInfo, может быть равен этому OpenMBeanParameterInfoSupport экземпляру, как определено в equals(java.lang.Object), но может иметь другой хэш-код, если он рассчитывается по-другому.

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

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

toString

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

Строковое представление состоит из имени этого класса (т.е. javax.management.openmbean.OpenMBeanParameterInfoSupport), строкового представления имени и открытого типа описываемого параметра, строкового представления его значений по умолчанию, мин, макс и допустимых значений, а также строкового представления его дескриптора.

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

Определяется:
toString в интерфейсе OpenMBeanParameterInfo
Переопределяет:
toString в классе Object
Возвращает:
строковое представление этого OpenMBeanParameterInfoSupport экземпляра.

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

Spec-Zone.ru

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