Класс 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`, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, со специфицированными `name`, `openType` и `description`.
`OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor)` Конструирует экземпляр `OpenMBeanParameterInfoSupport`, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, со специфицированными `name`, `openType`, `description`, и `descriptor`.
`OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue)` Конструирует экземпляр `OpenMBeanParameterInfoSupport`, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, со специфицированными `name`, `openType`, `description` и `defaultValue`.
`OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)` Конструирует экземпляр `OpenMBeanParameterInfoSupport`, который описывает параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBean, со специфицированными `name`, `openType`, `description`, `defaultValue`, `minValue` и `maxValue`.
`OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues)` Конструирует экземпляр `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)

Параметры:: name - не может быть пустой или нулевой строкой.; description - не может быть пустой или нулевой строкой.; openType - не может быть нулевым.
Исключения:: IllegalArgumentException - если name или description являются пустой или нулевой строкой, или openType является нулевым.

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name,
                                     String description,
                                     OpenType<?> openType,
                                     Descriptor descriptor)

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

Параметры:: name - не может быть пустой или нулевой строкой.; description - не может быть пустой или нулевой строкой.; openType - не может быть нулевым.; descriptor - Дескриптор параметра. Может быть нулевым, что эквивалентно пустому дескриптору.
Исключения:: IllegalArgumentException - если name или description являются пустой или нулевой строкой, или openType является нулевым, или записи дескриптора некорректны, как описано в описании пакета.
С тех пор:: 1.6

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name,
                                     String description,
                                     OpenType<T> openType,
                                     T defaultValue)
                              throws OpenDataException

Параметры типов:: T - позволяет компилятору проверить, что defaultValue, если не нулевой, имеет правильный тип Java для данного openType.
Параметры:: name - не может быть пустой или нулевой строкой.; description - не может быть пустой или нулевой строкой.; openType - не может быть нулевым.; defaultValue - должно быть допустимым значением для openType , указанным для этого параметра; значение по умолчанию не поддерживается для ArrayType и TabularType; может быть нулевым, что означает, что значение по умолчанию не задано.
Исключения:: IllegalArgumentException - если name или description являются пустой или нулевой строкой, или openType является нулевым.; OpenDataException - если defaultValue не является допустимым значением для указанного openType, или defaultValue не нулевой и openType является ArrayType или TabularType.

OpenMBeanParameterInfoSupport

public OpenMBeanParameterInfoSupport(String name,
                                     String description,
                                     OpenType<T> openType,
                                     T defaultValue,
                                     T[] legalValues)
                              throws OpenDataException

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

Параметры типов:: T - позволяет компилятору проверить, что defaultValue и legalValues, если не нулевые, имеют правильный тип Java для данного openType.
Параметры:: name - не может быть пустой или нулевой строкой.; description - не может быть пустой или нулевой строкой.; openType - не может быть нулевым.; defaultValue - должно быть допустимым значением для openType , указанным для этого параметра; значение по умолчанию не поддерживается для ArrayType и TabularType; может быть нулевым, что означает, что значение по умолчанию не задано.; legalValues - каждое содержащее значение должно быть допустимым значением для openType , указанным для этого параметра; допустимые значения не поддерживаются для ArrayType и TabularType; может быть нулевым или пустым.
Исключения:: IllegalArgumentException - если name или description являются пустой или нулевой строкой, или openType является нулевым.; OpenDataException - если defaultValue не является допустимым значением для указанного openType, или одно значение в legalValues не является допустимым для указанного openType, или defaultValue не нулевой и openType является ArrayType или TabularType, или legalValues не нулевой и не пустой и openType является ArrayType или TabularType, или legalValues не нулевой и не пустой и defaultValue не содержится в legalValues.

OpenMBeanParameterInfoSupport

public 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, если не нулевые, имеют правильный тип Java для данного openType.
Параметры:: name - не может быть пустой или нулевой строкой.; description - не может быть пустой или нулевой строкой.; openType - не может быть нулевым.; defaultValue - должно быть допустимым значением для openType , указанным для этого параметра; значение по умолчанию не поддерживается для ArrayType и TabularType; может быть нулевым, что означает, что значение по умолчанию не задано.; minValue - должно быть допустимым для openType , указанным для этого параметра; может быть нулевым, что означает, что минимальное значение не задано.; maxValue - должно быть допустимым для openType , указанным для этого параметра; может быть нулевым, что означает, что максимальное значение не задано.
Исключения:: IllegalArgumentException - если name или description являются пустой или нулевой строкой, или openType является нулевым.; OpenDataException - если defaultValue, minValue или maxValue не является допустимым значением для указанного openType, или defaultValue не нулевой и openType является ArrayType или TabularType, или оба minValue и maxValue не нулевые и minValue.compareTo(maxValue) > 0 равно true, или оба defaultValue и minValue не нулевые и minValue.compareTo(defaultValue) > 0 равно true, или оба defaultValue и maxValue не нулевые и 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,
их имена равны
их открытые типы равны
их значения по умолчанию, min, max и допустимые значения равны.

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

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

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

hashCode

public int hashCode()

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

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

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

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

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

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

toString

public String toString()

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

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

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

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

© 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.