Класс 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)

Создаёт экземпляр OpenMBeanParameterInfoSupport, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, со значениями указанными name, openType и description.

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

OpenMBeanParameterInfoSupport

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

Создаёт экземпляр OpenMBeanParameterInfoSupport, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, со значениями указанными name, openType, description, и descriptor.

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

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

OpenMBeanParameterInfoSupport

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

Создаёт экземпляр OpenMBeanParameterInfoSupport, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, со значениями указанными name, openType, description и defaultValue.

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

OpenMBeanParameterInfoSupport

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

Создаёт экземпляр OpenMBeanParameterInfoSupport, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, со значениями указанными name, openType, description, defaultValue и legalValues.

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

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

OpenMBeanParameterInfoSupport

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

Создаёт экземпляр OpenMBeanParameterInfoSupport, описывающий параметр, используемый в одной или нескольких операциях или конструкторах класса открытых MBeans, со значениями указанными name, openType, description, defaultValue, minValue и maxValue. Можно указать минимальные и максимальные значения только для открытого типа, значения которого являются Comparable.

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

toString

public String toString()

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

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

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

Определено в:
toString в интерфейсе OpenMBeanParameterInfo
Переопределяет:
toString в классе Object
Возвращает:
строковое представление данного 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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.management/javax/management/openmbean/OpenMBeanParameterInfoSupport.html

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