Класс OpenMBeanAttributeInfoSupport

Все реализуемые интерфейсы:
Serializable, Cloneable, DescriptorRead, OpenMBeanAttributeInfo, OpenMBeanParameterInfo 
public class OpenMBeanAttributeInfoSupport
extends MBeanAttributeInfo
implements OpenMBeanAttributeInfo

Описывает атрибут открытого MBean.

С момента:
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, а также указанными свойствами доступа read/write.
OpenMBeanAttributeInfoSupport​(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)

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

OpenMBeanAttributeInfoSupport​(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue)

Создает экземпляр OpenMBeanAttributeInfoSupport , который описывает атрибут открытого MBean с указанными name, openType, description и defaultValue, и указанными свойствами доступа read/write.
OpenMBeanAttributeInfoSupport​(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)

Создает экземпляр OpenMBeanAttributeInfoSupport , который описывает атрибут открытого 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 , который описывает атрибут открытого MBean с указанными name, openType, description, defaultValue и legalValues, и указанными свойствами доступа read/write.

Методы

Модификатор и тип Метод Описание
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.

Методы, объявленные в классе 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 если у атрибута есть экспонированный для управления метод получения значения.
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, или записи дескриптора некорректны, как описано в описании пакета.
Since:
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 если у атрибута есть экспонированный для управления метод получения значения.
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 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 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) равны
  • их значения по умолчанию, min, max и допустимые значения равны.
Это гарантирует, что этот 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 сравнениях (то есть его имя, его открытый тип, его значения по умолчанию, min, max и допустимые значения, а также его дескриптор).

Это гарантирует, что 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(java.lang.Object)

toString

public String toString()

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

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

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

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

© 1993, 2020, 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/11/docs/api/java.management/javax/management/openmbean/OpenMBeanAttributeInfoSupport.html

Spec-Zone .ru
спецификации, руководства, описания, API