Spec-Zone.ru › OpenJDK 27

Класс 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
См. также:
  • Сериализованная форма

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

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

description, name
Модификатор и тип Поле Описание
protected String description
Удобочитаемое описание функционального элемента.
protected String 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.

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

clone, getType
Модификатор и тип Метод Описание
Object clone()
Возвращает поверхностную копию этого экземпляра.
String getType()
Возвращает тип или имя класса данных.

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

getDescription, getDescriptor, getName
Модификатор и тип Метод Описание
String getDescription()
Возвращает удобочитаемое описание функционального элемента.
Descriptor getDescriptor()
Возвращает дескриптор функционального элемента.
String getName()
Возвращает имя функционального элемента.

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

finalize, getClass, notify, notifyAll, wait, wait, wait
Модификатор и тип Метод Описание
protected void finalize()
Устарело, подлежит удалению: этот элемент API может быть удален в будущей версии.
Финализация устарела и будет удалена в одном из будущих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
final void wait()
Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
final void wait(long timeoutMillis)
Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения определенного промежутка реального времени.
final void wait(long timeoutMillis, int nanos)
Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения определенного промежутка реального времени.

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

getDescription, getName
Модификатор и тип Метод Описание
String getDescription()
Возвращает удобочитаемое описание параметра, описанного этим экземпляром OpenMBeanParameterInfo.
String getName()
Возвращает имя параметра, описанного этим экземпляром OpenMBeanParameterInfo.

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

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, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, с указанными 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, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, с указанными 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, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, с указанными 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, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, с указанными 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(Object)

toString

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

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

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

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

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее дочерних компаний в США и других странах.
Авторское право © 1993, 2026, 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.

Spec-Zone.ru

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