Spec-Zone.ru › OpenJDK 27

Класс OpenMBeanAttributeInfoSupport

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanAttributeInfo
javax.management.openmbean.OpenMBeanAttributeInfoSupport
Все реализуемые интерфейсы:
Serializable, Cloneable, DescriptorRead, OpenMBeanAttributeInfo, OpenMBeanParameterInfo
public class OpenMBeanAttributeInfoSupport extends MBeanAttributeInfo implements OpenMBeanAttributeInfo
Описывает атрибут открытого MBean.
Начиная с:
1.5
См. также:
  • Сериализованная форма

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

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

description, name
Модификатор и тип Поле Описание
protected String description
Удобочитаемое описание элемента.
protected String name
Имя элемента.

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

OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs)
OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue)
OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)
OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, T[] legalValues)
Модификатор Конструктор Описание
Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType и description, а также указанными свойствами доступа для чтения и записи.
Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType, description, свойствами доступа для чтения и записи, а также Descriptor.
 <T> 
Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType, description и defaultValue, а также указанными свойствами доступа для чтения и записи.
 <T> 
Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType, description, defaultValue, minValue и maxValue.
 <T> 
Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType, description, defaultValue и legalValues, а также указанными свойствами доступа для чтения и записи.

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

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

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

clone, getType, isIs, isReadable, isWritable
Модификатор и тип Метод Описание
Object clone()
Возвращает поверхностную копию этого экземпляра.
String getType()
Возвращает имя класса атрибута.
boolean isIs()
Указывает, есть ли у этого атрибута getter «is».
boolean isReadable()
Можно ли прочитать значение атрибута.
boolean isWritable()
Можно ли записывать новые значения в атрибут.

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

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

isIs, isReadable, isWritable
Модификатор и тип Метод Описание
boolean isIs()
Возвращает true, если доступ к атрибуту, описанному этим экземпляром OpenMBeanAttributeInfo, осуществляется через getter isXXX (применяется только к значениям boolean и Boolean), и false в противном случае.
boolean isReadable()
Возвращает true, если атрибут, описанный этим экземпляром OpenMBeanAttributeInfo, доступен для чтения, и false в противном случае.
boolean isWritable()
Возвращает true, если атрибут, описанный этим экземпляром OpenMBeanAttributeInfo, доступен для записи, и false в противном случае.

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

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

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

OpenMBeanAttributeInfoSupport

public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs)
Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType и description, а также указанными свойствами доступа для чтения и записи.
Параметры:
name — не может быть null или пустой строкой.
description — не может быть null или пустой строкой.
openType — не может быть null.
isReadable — true, если для атрибута предоставлен геттер для управления.
isWritable — true, если для атрибута предоставлен сеттер для управления.
isIs — true, если геттер атрибута имеет форму isXXX.
Исключения:
IllegalArgumentException — если name или description равны null или пустой строке либо openType равен null.

OpenMBeanAttributeInfoSupport

public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)

Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType, description, свойствами доступа для чтения и записи, а также Descriptor.

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

Параметры:
name — не может быть null или пустой строкой.
description — не может быть null или пустой строкой.
openType — не может быть null.
isReadable — true, если для атрибута предоставлен геттер для управления.
isWritable — true, если для атрибута предоставлен сеттер для управления.
isIs — true, если геттер атрибута имеет форму isXXX.
descriptor — дескриптор атрибута. Может быть null, что эквивалентно пустому дескриптору.
Исключения:
IllegalArgumentException — если name или description равны null или пустой строке, openType равен null либо записи дескриптора недопустимы, как описано в описании пакета.
Начиная с:
1.6

OpenMBeanAttributeInfoSupport

public <T> OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue) throws OpenDataException
Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType, description и defaultValue, а также указанными свойствами доступа для чтения и записи.
Параметры типа:
T — позволяет компилятору проверить, что defaultValue, если он не равен null, имеет правильный тип Java для заданного openType.
Параметры:
name — не может быть null или пустой строкой.
description — не может быть null или пустой строкой.
openType — не может быть null.
isReadable — true, если для атрибута предоставлен геттер для управления.
isWritable — true, если для атрибута предоставлен сеттер для управления.
isIs — true, если геттер атрибута имеет форму isXXX.
defaultValue — должно быть допустимым значением для openType, указанного для этого атрибута; значение по умолчанию не поддерживается для ArrayType и TabularType; может быть null, что означает, что значение по умолчанию не задано.
Исключения:
IllegalArgumentException — если name или description равны null или пустой строке либо openType равен null.
OpenDataException — если defaultValue не является допустимым значением для указанного openType либо defaultValue не равен null, а openType является ArrayType или TabularType.

OpenMBeanAttributeInfoSupport

public <T> OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, T[] legalValues) throws OpenDataException

Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType, description, defaultValue и legalValues, а также указанными свойствами доступа для чтения и записи.

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

Параметры типа:
T — позволяет компилятору проверить, что defaultValue и legalValues, если они не равны null, имеют правильный тип Java для заданного openType.
Параметры:
name — не может быть null или пустой строкой.
description — не может быть null или пустой строкой.
openType — не может быть null.
isReadable — true, если для атрибута предоставлен геттер для управления.
isWritable — true, если для атрибута предоставлен сеттер для управления.
isIs — true, если геттер атрибута имеет форму isXXX.
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.

OpenMBeanAttributeInfoSupport

public <T> OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue) throws OpenDataException
Создает экземпляр OpenMBeanAttributeInfoSupport, описывающий атрибут открытого MBean с указанными name, openType, description, defaultValue, minValue и maxValue. Минимальное и максимальное значения можно указать только для открытого типа, значения которого являются Comparable.
Параметры типа:
T — позволяет компилятору проверить, что defaultValue, minValue и maxValue, если они не равны null, имеют правильный тип Java для заданного openType.
Параметры:
name — не может быть null или пустой строкой.
description — не может быть null или пустой строкой.
openType — не может быть null.
isReadable — true, если для атрибута предоставлен геттер для управления.
isWritable — true, если для атрибута предоставлен сеттер для управления.
isIs — true, если геттер атрибута имеет форму isXXX.
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()
Возвращает открытый тип значений атрибута, описанного этим экземпляром OpenMBeanAttributeInfoSupport.
Определен в:
getOpenType в интерфейсе OpenMBeanParameterInfo
Возвращает:
открытый тип.

getDefaultValue

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

getLegalValues

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

getMinValue

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

getMaxValue

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

hasDefaultValue

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

hasLegalValues

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

hasMinValue

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

hasMaxValue

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

isValue

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

equals

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

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

  • obj не равен null;
  • obj также реализует интерфейс OpenMBeanAttributeInfo;
  • их имена равны;
  • их открытые типы равны;
  • их свойства доступа (isReadable, isWritable и isIs) равны;
  • их значения по умолчанию, минимальные, максимальные и допустимые значения равны.
Это гарантирует, что данный метод equals корректно работает с параметрами obj, представляющими собой разные реализации интерфейса OpenMBeanAttributeInfo.

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

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

hashCode

public int hashCode()

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

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

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

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

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

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

toString

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

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

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

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

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по 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