Spec-Zone.ru › OpenJDK 21

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

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

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

description, name

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

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

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

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

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

clone, getType, isIs, isReadable, isWritable

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

getDescription, getDescriptor, getName

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

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

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

isIs, isReadable, isWritable

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

getDescription, getName

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

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, если для атрибута доступен getter для управления.
isWritable - true, если для атрибута доступен setter для управления.
isIs - true, если getter атрибута имеет вид 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, если для атрибута доступен getter для управления.
isWritable - true, если для атрибута доступен setter для управления.
isIs - true, если getter атрибута имеет вид isXXX.
descriptor - Дескриптор атрибута. Может быть null, что эквивалентно пустому дескриптору.
Исключения:
IllegalArgumentException - если name или description являются null или пустой строкой, или openType имеет значение null, или записи дескриптора неверны, как описано в описании пакета.
С тех пор:
1.6

OpenMBeanAttributeInfoSupport

public 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, если для атрибута доступен getter для управления.
isWritable - true, если для атрибута доступен setter для управления.
isIs - true, если getter атрибута имеет вид isXXX.
defaultValue - должно быть допустимым значением для openType для данного атрибута; значение по умолчанию не поддерживается для ArrayType и TabularType; может быть null, что означает отсутствие значения по умолчанию.
Исключения:
IllegalArgumentException - если name или description являются null или пустой строкой, или openType имеет значение null.
OpenDataException - если defaultValue не является допустимым значением для указанного openType, или defaultValue не null, и openType является ArrayType или TabularType.

OpenMBeanAttributeInfoSupport

public 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, если для атрибута доступен getter для управления.
isWritable - true, если для атрибута доступен setter для управления.
isIs - true, если getter атрибута имеет вид 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 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.
Type Parameters:
T - позволяет компилятору проверить, что defaultValue, minValue, и maxValue, если они не null, имеют правильный тип Java для заданного openType.
Parameters:
name - не может быть null или пустой строкой.
description - не может быть null или пустой строкой.
openType - не может быть null.
isReadable - true, если у атрибута есть экспонированный для управления метод-геттер.
isWritable - true, если у атрибута есть экспонированный для управления метод-сеттер.
isIs - true, если геттер атрибута имеет вид isXXX.
defaultValue - должно быть допустимым значением для openType, указанного для этого атрибута; значение по умолчанию не поддерживается для ArrayType и TabularType; может быть null, что означает, что значение по умолчанию не установлено.
minValue - должно быть допустимым для openType, указанного для этого атрибута; может быть null, что означает, что минимальное значение не установлено.
maxValue - должно быть допустимым для openType, указанного для этого атрибута; может быть null, что означает, что максимальное значение не установлено.
Throws:
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.
Specified by:
getOpenType в интерфейсе OpenMBeanParameterInfo
Returns:
открытый тип.

getDefaultValue

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

getLegalValues

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

getMinValue

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

getMaxValue

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

hasDefaultValue

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

hasLegalValues

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

hasMinValue

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

hasMaxValue

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

isValue

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

equals

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

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

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

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

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

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

toString

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

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

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

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

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

Spec-Zone.ru

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