- All Implemented Interfaces:
Serializable,Cloneable,DescriptorRead,OpenMBeanParameterInfo
- Since:
- 1.5
- See Also:
-
Field Summary
Fields declared in class javax.management.MBeanFeatureInfo
description, name -
Constructor Summary
ConstructorsConstructorDescriptionOpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType) Constructs anOpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openTypeanddescription.OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor) Constructs anOpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openType,description, anddescriptor.OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue) Constructs anOpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openType,descriptionanddefaultValue.OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue) Constructs anOpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openType,description,defaultValue,minValueandmaxValue.OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues) Constructs anOpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openType,description,defaultValueandlegalValues. -
Method Summary
Modifier and TypeMethodDescriptionbooleanCompares the specifiedobjparameter with thisOpenMBeanParameterInfoSupportinstance for equality.Returns the default value for the parameter described by thisOpenMBeanParameterInfoSupportinstance, if specified, ornullotherwise.Set<?> Returns an unmodifiable Set of legal values for the parameter described by thisOpenMBeanParameterInfoSupportinstance, if specified, ornullotherwise.Comparable<?> Returns the maximal value for the parameter described by thisOpenMBeanParameterInfoSupportinstance, if specified, ornullotherwise.Comparable<?> Returns the minimal value for the parameter described by thisOpenMBeanParameterInfoSupportinstance, if specified, ornullotherwise.OpenType<?> Returns the open type for the values of the parameter described by thisOpenMBeanParameterInfoSupportinstance.booleanReturnstrueif thisOpenMBeanParameterInfoSupportinstance specifies a non-null default value for the described parameter,falseotherwise.inthashCode()Returns the hash code value for thisOpenMBeanParameterInfoSupportinstance.booleanReturnstrueif thisOpenMBeanParameterInfoSupportinstance specifies a non-null set of legal values for the described parameter,falseotherwise.booleanReturnstrueif thisOpenMBeanParameterInfoSupportinstance specifies a non-null maximal value for the described parameter,falseotherwise.booleanReturnstrueif thisOpenMBeanParameterInfoSupportinstance specifies a non-null minimal value for the described parameter,falseotherwise.booleanTests whetherobjis a valid value for the parameter described by thisOpenMBeanParameterInfoinstance.toString()Returns a string representation of thisOpenMBeanParameterInfoSupportinstance.Methods declared in class javax.management.MBeanParameterInfo
clone, getTypeMethods declared in class javax.management.MBeanFeatureInfo
getDescription, getDescriptor, getNameMethods declared in interface javax.management.openmbean.OpenMBeanParameterInfo
getDescription, getName
-
Constructor Details
-
OpenMBeanParameterInfoSupport
Constructs anOpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openTypeanddescription.- Parameters:
name- cannot be a null or empty string.description- cannot be a null or empty string.openType- cannot be null.- Throws:
IllegalArgumentException- ifnameordescriptionare null or empty string, oropenTypeis null.
-
OpenMBeanParameterInfoSupport
public OpenMBeanParameterInfoSupport(String name, String description, OpenType<?> openType, Descriptor descriptor) Constructs anOpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openType,description, anddescriptor.The
descriptorcan contain entries that will define the values returned by certain methods of this class, as explained in the package description.- Parameters:
name- cannot be a null or empty string.description- cannot be a null or empty string.openType- cannot be null.descriptor- The descriptor for the parameter. This may be null which is equivalent to an empty descriptor.- Throws:
IllegalArgumentException- ifnameordescriptionare null or empty string, oropenTypeis null, or the descriptor entries are invalid as described in the package description.- Since:
- 1.6
-
OpenMBeanParameterInfoSupport
public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue) throws OpenDataException Constructs anOpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openType,descriptionanddefaultValue.- Type Parameters:
T- allows the compiler to check that thedefaultValue, if non-null, has the correct Java type for the givenopenType.- Parameters:
name- cannot be a null or empty string.description- cannot be a null or empty string.openType- cannot be null.defaultValue- must be a valid value for theopenTypespecified for this parameter; default value not supported forArrayTypeandTabularType; can be null, in which case it means that no default value is set.- Throws:
IllegalArgumentException- ifnameordescriptionare null or empty string, oropenTypeis null.OpenDataException- ifdefaultValueis not a valid value for the specifiedopenType, ordefaultValueis non null andopenTypeis anArrayTypeor aTabularType.
-
OpenMBeanParameterInfoSupport
public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, T[] legalValues) throws OpenDataException Constructs an
OpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openType,description,defaultValueandlegalValues.The contents of
legalValuesare copied, so subsequent modifications of the array referenced bylegalValueshave no impact on thisOpenMBeanParameterInfoSupportinstance.- Type Parameters:
T- allows the compiler to check that thedefaultValueandlegalValues, if non-null, have the correct Java type for the givenopenType.- Parameters:
name- cannot be a null or empty string.description- cannot be a null or empty string.openType- cannot be null.defaultValue- must be a valid value for theopenTypespecified for this parameter; default value not supported forArrayTypeandTabularType; can be null, in which case it means that no default value is set.legalValues- each contained value must be valid for theopenTypespecified for this parameter; legal values not supported forArrayTypeandTabularType; can be null or empty.- Throws:
IllegalArgumentException- ifnameordescriptionare null or empty string, oropenTypeis null.OpenDataException- ifdefaultValueis not a valid value for the specifiedopenType, or one value inlegalValuesis not valid for the specifiedopenType, ordefaultValueis non null andopenTypeis anArrayTypeor aTabularType, orlegalValuesis non null and non empty andopenTypeis anArrayTypeor aTabularType, orlegalValuesis non null and non empty anddefaultValueis not contained inlegalValues.
-
OpenMBeanParameterInfoSupport
public OpenMBeanParameterInfoSupport(String name, String description, OpenType<T> openType, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue) throws OpenDataException Constructs anOpenMBeanParameterInfoSupportinstance, which describes the parameter used in one or more operations or constructors of a class of open MBeans, with the specifiedname,openType,description,defaultValue,minValueandmaxValue. It is possible to specify minimal and maximal values only for an open type whose values areComparable.- Type Parameters:
T- allows the compiler to check that thedefaultValue,minValue, andmaxValue, if non-null, have the correct Java type for the givenopenType.- Parameters:
name- cannot be a null or empty string.description- cannot be a null or empty string.openType- cannot be null.defaultValue- must be a valid value for theopenTypespecified for this parameter; default value not supported forArrayTypeandTabularType; can be null, in which case it means that no default value is set.minValue- must be valid for theopenTypespecified for this parameter; can be null, in which case it means that no minimal value is set.maxValue- must be valid for theopenTypespecified for this parameter; can be null, in which case it means that no maximal value is set.- Throws:
IllegalArgumentException- ifnameordescriptionare null or empty string, oropenTypeis null.OpenDataException- ifdefaultValue,minValueormaxValueis not a valid value for the specifiedopenType, ordefaultValueis non null andopenTypeis anArrayTypeor aTabularType, or bothminValueandmaxValueare non-null andminValue.compareTo(maxValue) > 0istrue, or bothdefaultValueandminValueare non-null andminValue.compareTo(defaultValue) > 0istrue, or bothdefaultValueandmaxValueare non-null anddefaultValue.compareTo(maxValue) > 0istrue.
-
-
Method Details
-
getOpenType
Returns the open type for the values of the parameter described by thisOpenMBeanParameterInfoSupportinstance.- Specified by:
getOpenTypein interfaceOpenMBeanParameterInfo- Returns:
- the open type.
-
getDefaultValue
Returns the default value for the parameter described by thisOpenMBeanParameterInfoSupportinstance, if specified, ornullotherwise.- Specified by:
getDefaultValuein interfaceOpenMBeanParameterInfo- Returns:
- the default value.
-
getLegalValues
Returns an unmodifiable Set of legal values for the parameter described by thisOpenMBeanParameterInfoSupportinstance, if specified, ornullotherwise.- Specified by:
getLegalValuesin interfaceOpenMBeanParameterInfo- Returns:
- the set of legal values.
-
getMinValue
Returns the minimal value for the parameter described by thisOpenMBeanParameterInfoSupportinstance, if specified, ornullotherwise.- Specified by:
getMinValuein interfaceOpenMBeanParameterInfo- Returns:
- the minimum value.
-
getMaxValue
Returns the maximal value for the parameter described by thisOpenMBeanParameterInfoSupportinstance, if specified, ornullotherwise.- Specified by:
getMaxValuein interfaceOpenMBeanParameterInfo- Returns:
- the maximum value.
-
hasDefaultValue
public boolean hasDefaultValue()Returnstrueif thisOpenMBeanParameterInfoSupportinstance specifies a non-null default value for the described parameter,falseotherwise.- Specified by:
hasDefaultValuein interfaceOpenMBeanParameterInfo- Returns:
- true if there is a default value.
-
hasLegalValues
public boolean hasLegalValues()Returnstrueif thisOpenMBeanParameterInfoSupportinstance specifies a non-null set of legal values for the described parameter,falseotherwise.- Specified by:
hasLegalValuesin interfaceOpenMBeanParameterInfo- Returns:
- true if there is a set of legal values.
-
hasMinValue
public boolean hasMinValue()Returnstrueif thisOpenMBeanParameterInfoSupportinstance specifies a non-null minimal value for the described parameter,falseotherwise.- Specified by:
hasMinValuein interfaceOpenMBeanParameterInfo- Returns:
- true if there is a minimum value.
-
hasMaxValue
public boolean hasMaxValue()Returnstrueif thisOpenMBeanParameterInfoSupportinstance specifies a non-null maximal value for the described parameter,falseotherwise.- Specified by:
hasMaxValuein interfaceOpenMBeanParameterInfo- Returns:
- true if there is a maximum value.
-
isValue
Tests whetherobjis a valid value for the parameter described by thisOpenMBeanParameterInfoinstance.- Specified by:
isValuein interfaceOpenMBeanParameterInfo- Parameters:
obj- the object to be tested.- Returns:
trueifobjis a valid value for the parameter described by thisOpenMBeanParameterInfoinstance,falseotherwise.
-
equals
Compares the specified
objparameter with thisOpenMBeanParameterInfoSupportinstance for equality.Returns
trueif and only if all of the following statements are true:objis non null,objalso implements theOpenMBeanParameterInfointerface,- their names are equal
- their open types are equal
- their default, min, max and legal values are equal.
equalsmethod works properly forobjparameters which are different implementations of theOpenMBeanParameterInfointerface.If
objalso implementsDescriptorRead, then itsgetDescriptor()method must also return the same value as for this object.- Specified by:
equalsin interfaceOpenMBeanParameterInfo- Overrides:
equalsin classMBeanParameterInfo- Parameters:
obj- the object to be compared for equality with thisOpenMBeanParameterInfoSupportinstance.- Returns:
trueif the specified object is equal to thisOpenMBeanParameterInfoSupportinstance.- See Also:
-
hashCode
public int hashCode()Returns the hash code value for this
OpenMBeanParameterInfoSupportinstance.The hash code of an
OpenMBeanParameterInfoSupportinstance is the sum of the hash codes of all elements of information used inequalscomparisons (ie: its name, its open type, its default, min, max and legal values, and its Descriptor).This ensures that
t1.equals(t2)implies thatt1.hashCode()==t2.hashCode()for any twoOpenMBeanParameterInfoSupportinstancest1andt2, as required by the general contract of the methodObject.hashCode().However, note that another instance of a class implementing the
OpenMBeanParameterInfointerface may be equal to thisOpenMBeanParameterInfoSupportinstance as defined byequals(java.lang.Object), but may have a different hash code if it is calculated differently.As
OpenMBeanParameterInfoSupportinstances are immutable, the hash code for this instance is calculated once, on the first call tohashCode, and then the same value is returned for subsequent calls.- Specified by:
hashCodein interfaceOpenMBeanParameterInfo- Overrides:
hashCodein classObject- Returns:
- the hash code value for this
OpenMBeanParameterInfoSupportinstance - See Also:
-
toString
Returns a string representation of thisOpenMBeanParameterInfoSupportinstance.The string representation consists of the name of this class (i.e.
javax.management.openmbean.OpenMBeanParameterInfoSupport), the string representation of the name and open type of the described parameter, the string representation of its default, min, max and legal values and the string representation of its descriptor.As
OpenMBeanParameterInfoSupportinstances are immutable, the string representation for this instance is calculated once, on the first call totoString, and then the same value is returned for subsequent calls.- Specified by:
toStringin interfaceOpenMBeanParameterInfo- Overrides:
toStringin classObject- Returns:
- a string representation of this
OpenMBeanParameterInfoSupportinstance.
-