- java.lang.Object
-
- javax.management.MBeanFeatureInfo
-
- javax.management.MBeanAttributeInfo
-
- javax.management.openmbean.OpenMBeanAttributeInfoSupport
-
- All Implemented Interfaces:
Serializable,Cloneable,DescriptorRead,OpenMBeanAttributeInfo,OpenMBeanParameterInfo
public class OpenMBeanAttributeInfoSupport extends MBeanAttributeInfo implements OpenMBeanAttributeInfo
Describes an attribute of an open MBean.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields declared in class javax.management.MBeanFeatureInfo
description, name
-
-
Constructor Summary
Constructors Constructor Description OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs)Constructs anOpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean with the specifiedname,openTypeanddescription, and the specified read/write access properties.OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)Constructs anOpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean with the specifiedname,openType,description, read/write access properties, andDescriptor.OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue)Constructs anOpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean with the specifiedname,openType,descriptionanddefaultValue, and the specified read/write access properties.OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, Comparable<T> minValue, Comparable<T> maxValue)Constructs anOpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean, with the specifiedname,openType,description,defaultValue,minValueandmaxValue.OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, T[] legalValues)Constructs anOpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean with the specifiedname,openType,description,defaultValueandlegalValues, and the specified read/write access properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)Compares the specifiedobjparameter with thisOpenMBeanAttributeInfoSupportinstance for equality.ObjectgetDefaultValue()Returns the default value for the attribute described by thisOpenMBeanAttributeInfoSupportinstance, if specified, ornullotherwise.Set<?>getLegalValues()Returns an unmodifiable Set of legal values for the attribute described by thisOpenMBeanAttributeInfoSupportinstance, if specified, ornullotherwise.Comparable<?>getMaxValue()Returns the maximal value for the attribute described by thisOpenMBeanAttributeInfoSupportinstance, if specified, ornullotherwise.Comparable<?>getMinValue()Returns the minimal value for the attribute described by thisOpenMBeanAttributeInfoSupportinstance, if specified, ornullotherwise.OpenType<?>getOpenType()Returns the open type for the values of the attribute described by thisOpenMBeanAttributeInfoSupportinstance.booleanhasDefaultValue()Returnstrueif thisOpenMBeanAttributeInfoSupportinstance specifies a non-null default value for the described attribute,falseotherwise.inthashCode()Returns the hash code value for thisOpenMBeanAttributeInfoSupportinstance.booleanhasLegalValues()Returnstrueif thisOpenMBeanAttributeInfoSupportinstance specifies a non-null set of legal values for the described attribute,falseotherwise.booleanhasMaxValue()Returnstrueif thisOpenMBeanAttributeInfoSupportinstance specifies a non-null maximal value for the described attribute,falseotherwise.booleanhasMinValue()Returnstrueif thisOpenMBeanAttributeInfoSupportinstance specifies a non-null minimal value for the described attribute,falseotherwise.booleanisValue(Object obj)Tests whetherobjis a valid value for the attribute described by thisOpenMBeanAttributeInfoSupportinstance.StringtoString()Returns a string representation of thisOpenMBeanAttributeInfoSupportinstance.-
Methods declared in class javax.management.MBeanAttributeInfo
clone, getType, isIs, isReadable, isWritable
-
Methods declared in class javax.management.MBeanFeatureInfo
getDescription, getDescriptor, getName
-
Methods declared in interface javax.management.openmbean.OpenMBeanAttributeInfo
isIs, isReadable, isWritable
-
Methods declared in interface javax.management.openmbean.OpenMBeanParameterInfo
getDescription, getName
-
-
-
-
Constructor Detail
-
OpenMBeanAttributeInfoSupport
public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs)
Constructs anOpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean with the specifiedname,openTypeanddescription, and the specified read/write access properties.- Parameters:
name- cannot be a null or empty string.description- cannot be a null or empty string.openType- cannot be null.isReadable-trueif the attribute has a getter exposed for management.isWritable-trueif the attribute has a setter exposed for management.isIs-trueif the attribute's getter is of the formisXXX.- Throws:
IllegalArgumentException- ifnameordescriptionare null or empty string, oropenTypeis null.
-
OpenMBeanAttributeInfoSupport
public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<?> openType, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
Constructs an
OpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean with the specifiedname,openType,description, read/write access properties, 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.isReadable-trueif the attribute has a getter exposed for management.isWritable-trueif the attribute has a setter exposed for management.isIs-trueif the attribute's getter is of the formisXXX.descriptor- The descriptor for the attribute. 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
-
OpenMBeanAttributeInfoSupport
public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue) throws OpenDataException
Constructs anOpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean with the specifiedname,openType,descriptionanddefaultValue, and the specified read/write access properties.- 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.isReadable-trueif the attribute has a getter exposed for management.isWritable-trueif the attribute has a setter exposed for management.isIs-trueif the attribute's getter is of the formisXXX.defaultValue- must be a valid value for theopenTypespecified for this attribute; 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.
-
OpenMBeanAttributeInfoSupport
public OpenMBeanAttributeInfoSupport(String name, String description, OpenType<T> openType, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, T[] legalValues) throws OpenDataException
Constructs an
OpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean with the specifiedname,openType,description,defaultValueandlegalValues, and the specified read/write access properties.The contents of
legalValuesare copied, so subsequent modifications of the array referenced bylegalValueshave no impact on thisOpenMBeanAttributeInfoSupportinstance.- 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.isReadable-trueif the attribute has a getter exposed for management.isWritable-trueif the attribute has a setter exposed for management.isIs-trueif the attribute's getter is of the formisXXX.defaultValue- must be a valid value for theopenTypespecified for this attribute; 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 attribute; 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.
-
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
Constructs anOpenMBeanAttributeInfoSupportinstance, which describes the attribute of an open MBean, 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.isReadable-trueif the attribute has a getter exposed for management.isWritable-trueif the attribute has a setter exposed for management.isIs-trueif the attribute's getter is of the formisXXX.defaultValue- must be a valid value for theopenTypespecified for this attribute; 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 attribute; can be null, in which case it means that no minimal value is set.maxValue- must be valid for theopenTypespecified for this attribute; 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 Detail
-
getOpenType
public OpenType<?> getOpenType()
Returns the open type for the values of the attribute described by thisOpenMBeanAttributeInfoSupportinstance.- Specified by:
getOpenTypein interfaceOpenMBeanParameterInfo- Returns:
- the open type.
-
getDefaultValue
public Object getDefaultValue()
Returns the default value for the attribute described by thisOpenMBeanAttributeInfoSupportinstance, if specified, ornullotherwise.- Specified by:
getDefaultValuein interfaceOpenMBeanParameterInfo- Returns:
- the default value.
-
getLegalValues
public Set<?> getLegalValues()
Returns an unmodifiable Set of legal values for the attribute described by thisOpenMBeanAttributeInfoSupportinstance, if specified, ornullotherwise.- Specified by:
getLegalValuesin interfaceOpenMBeanParameterInfo- Returns:
- the set of legal values.
-
getMinValue
public Comparable<?> getMinValue()
Returns the minimal value for the attribute described by thisOpenMBeanAttributeInfoSupportinstance, if specified, ornullotherwise.- Specified by:
getMinValuein interfaceOpenMBeanParameterInfo- Returns:
- the minimum value.
-
getMaxValue
public Comparable<?> getMaxValue()
Returns the maximal value for the attribute described by thisOpenMBeanAttributeInfoSupportinstance, if specified, ornullotherwise.- Specified by:
getMaxValuein interfaceOpenMBeanParameterInfo- Returns:
- the maximum value.
-
hasDefaultValue
public boolean hasDefaultValue()
Returnstrueif thisOpenMBeanAttributeInfoSupportinstance specifies a non-null default value for the described attribute,falseotherwise.- Specified by:
hasDefaultValuein interfaceOpenMBeanParameterInfo- Returns:
- true if there is a default value.
-
hasLegalValues
public boolean hasLegalValues()
Returnstrueif thisOpenMBeanAttributeInfoSupportinstance specifies a non-null set of legal values for the described attribute,falseotherwise.- Specified by:
hasLegalValuesin interfaceOpenMBeanParameterInfo- Returns:
- true if there is a set of legal values.
-
hasMinValue
public boolean hasMinValue()
Returnstrueif thisOpenMBeanAttributeInfoSupportinstance specifies a non-null minimal value for the described attribute,falseotherwise.- Specified by:
hasMinValuein interfaceOpenMBeanParameterInfo- Returns:
- true if there is a minimum value.
-
hasMaxValue
public boolean hasMaxValue()
Returnstrueif thisOpenMBeanAttributeInfoSupportinstance specifies a non-null maximal value for the described attribute,falseotherwise.- Specified by:
hasMaxValuein interfaceOpenMBeanParameterInfo- Returns:
- true if there is a maximum value.
-
isValue
public boolean isValue(Object obj)
Tests whetherobjis a valid value for the attribute described by thisOpenMBeanAttributeInfoSupportinstance.- Specified by:
isValuein interfaceOpenMBeanParameterInfo- Parameters:
obj- the object to be tested.- Returns:
trueifobjis a valid value for the parameter described by thisOpenMBeanAttributeInfoSupportinstance,falseotherwise.
-
equals
public boolean equals(Object obj)
Compares the specifiedobjparameter with thisOpenMBeanAttributeInfoSupportinstance for equality.Returns
trueif and only if all of the following statements are true:objis non null,objalso implements theOpenMBeanAttributeInfointerface,- their names are equal
- their open types are equal
- their access properties (isReadable, isWritable and isIs) are equal
- their default, min, max and legal values are equal.
equalsmethod works properly forobjparameters which are different implementations of theOpenMBeanAttributeInfointerface.If
objalso implementsDescriptorRead, then itsgetDescriptor()method must also return the same value as for this object.- Specified by:
equalsin interfaceOpenMBeanAttributeInfo- Specified by:
equalsin interfaceOpenMBeanParameterInfo- Overrides:
equalsin classMBeanAttributeInfo- Parameters:
obj- the object to be compared for equality with thisOpenMBeanAttributeInfoSupportinstance.- Returns:
trueif the specified object is equal to thisOpenMBeanAttributeInfoSupportinstance.- See Also:
Object.hashCode()
-
hashCode
public int hashCode()
Returns the hash code value for this
OpenMBeanAttributeInfoSupportinstance.The hash code of an
OpenMBeanAttributeInfoSupportinstance 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 twoOpenMBeanAttributeInfoSupportinstancest1andt2, as required by the general contract of the methodObject.hashCode().However, note that another instance of a class implementing the
OpenMBeanAttributeInfointerface may be equal to thisOpenMBeanAttributeInfoSupportinstance as defined byequals(java.lang.Object), but may have a different hash code if it is calculated differently.As
OpenMBeanAttributeInfoSupportinstances 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 interfaceOpenMBeanAttributeInfo- Specified by:
hashCodein interfaceOpenMBeanParameterInfo- Overrides:
hashCodein classObject- Returns:
- the hash code value for this
OpenMBeanAttributeInfoSupportinstance - See Also:
Object.equals(java.lang.Object)
-
toString
public String toString()
Returns a string representation of thisOpenMBeanAttributeInfoSupportinstance.The string representation consists of the name of this class (i.e.
javax.management.openmbean.OpenMBeanAttributeInfoSupport), 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
OpenMBeanAttributeInfoSupportinstances 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 interfaceOpenMBeanAttributeInfo- Specified by:
toStringin interfaceOpenMBeanParameterInfo- Overrides:
toStringin classObject- Returns:
- a string representation of this
OpenMBeanAttributeInfoSupportinstance.
-
-