Spec-Zone.ru › OpenJDK 24

Класс 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(String name, String description, OpenType<?> openType, Descriptor descriptor)
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue)
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)
OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues)
Модификатор Конструктор Описание
Создаёт экземпляр OpenMBeanParameterInfoSupport, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, с указанными name, openType и description.
Создаёт экземпляр OpenMBeanParameterInfoSupport, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, с указанными name, openType, description и descriptor.
 <T> 
Создаёт экземпляр OpenMBeanParameterInfoSupport, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, с указанными name, openType, description и defaultValue.
 <T> 
Создаёт экземпляр OpenMBeanParameterInfoSupport, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, с указанными name, openType, description, defaultValue, minValue и maxValue.
 <T> 
Создаёт экземпляр 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, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, со следующими заданными значениями: 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 <T> 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 <T> 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 <T> 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 в противном случае.
Specified by:
getLegalValues в интерфейсе OpenMBeanParameterInfo
Returns:
набор допустимых значений.

getMinValue

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

getMaxValue

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

hasDefaultValue

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

hasLegalValues

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

hasMinValue

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

hasMaxValue

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

isValue

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

equals

public boolean equals(Object obj)

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

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

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

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

Specified by:
equals в интерфейсе OpenMBeanParameterInfo
Overrides:
equals в классе MBeanParameterInfo
Parameters:
obj - объект, подлежащий сравнению на равенство с этим OpenMBeanParameterInfoSupport экземпляром.
Returns:
true, если указанный объект равен этому OpenMBeanParameterInfoSupport экземпляру.
See Also:
  • 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, а затем то же значение возвращается для последующих вызовов.

Specified by:
hashCode в интерфейсе OpenMBeanParameterInfo
Overrides:
hashCode в классе Object
Returns:
значение хэш-кода для этого OpenMBeanParameterInfoSupport экземпляра
See Also:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

toString

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

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

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

Specified by:
toString в интерфейсе OpenMBeanParameterInfo
Overrides:
toString в классе Object
Returns:
строковое представление этого OpenMBeanParameterInfoSupport экземпляра.

© 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://download.java.net/java/early_access/jdk24/docs/api/java.management/javax/management/openmbean/OpenMBeanParameterInfoSupport.html

Spec-Zone.ru

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