|
J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.management.MBeanFeatureInfo
javax.management.MBeanAttributeInfo
javax.management.openmbean.OpenMBeanAttributeInfoSupport
Describes an attribute of an open MBean.
| Field Summary |
| Fields inherited from class javax.management.MBeanFeatureInfo |
description, name |
| Constructor Summary | |
OpenMBeanAttributeInfoSupport(java.lang.String name,
java.lang.String description,
OpenType openType,
boolean isReadable,
boolean isWritable,
boolean isIs)
Constructs an OpenMBeanAttributeInfoSupport instance, which describes the attribute of an open MBean with the specified name, openType and description, and the specified read/write access properties. |
|
OpenMBeanAttributeInfoSupport(java.lang.String name,
java.lang.String description,
OpenType openType,
boolean isReadable,
boolean isWritable,
boolean isIs,
java.lang.Object defaultValue)
Constructs an OpenMBeanAttributeInfoSupport instance, which describes the attribute of an open MBean with the specified name, openType, description and defaultValue, and the specified read/write access properties. |
|
OpenMBeanAttributeInfoSupport(java.lang.String name,
java.lang.String description,
OpenType openType,
boolean isReadable,
boolean isWritable,
boolean isIs,
java.lang.Object defaultValue,
java.lang.Comparable minValue,
java.lang.Comparable maxValue)
Constructs an OpenMBeanAttributeInfoSupport instance, which describes the attribute used in one or more operations or constructors of a class of open MBeans, with the specified name, openType, description, defaultValue, minValue and maxValue. |
|
OpenMBeanAttributeInfoSupport(java.lang.String name,
java.lang.String description,
OpenType openType,
boolean isReadable,
boolean isWritable,
boolean isIs,
java.lang.Object defaultValue,
java.lang.Object[] legalValues)
Constructs an OpenMBeanAttributeInfoSupport instance, which describes the attribute of an open MBean with the specified name, openType, description, defaultValue and legalValues, and the specified read/write access properties. |
|
| Method Summary | |
boolean |
equals(java.lang.Object obj)
Compares the specified obj parameter with this OpenMBeanAttributeInfoSupport instance for equality.
|
java.lang.Object |
getDefaultValue()
Returns the default value for the attribute described by this OpenMBeanAttributeInfoSupport instance, if specified, or null otherwise. |
java.util.Set |
getLegalValues()
Returns an unmodifiable Set of legal values for the attribute described by this OpenMBeanAttributeInfoSupport instance, if specified, or null otherwise. |
java.lang.Comparable |
getMaxValue()
Returns the maximal value for the attribute described by this OpenMBeanAttributeInfoSupport instance, if specified, or null otherwise. |
java.lang.Comparable |
getMinValue()
Returns the minimal value for the attribute described by this OpenMBeanAttributeInfoSupport instance, if specified, or null otherwise. |
OpenType |
getOpenType()
Returns the open type for the values of the attribute described by this OpenMBeanAttributeInfoSupport instance. |
boolean |
hasDefaultValue()
Returns true if this OpenMBeanAttributeInfoSupport instance specifies a non-null default value for the described attribute, false otherwise. |
int |
hashCode()
Returns the hash code value for this OpenMBeanAttributeInfoSupport instance.
|
boolean |
hasLegalValues()
Returns true if this OpenMBeanAttributeInfoSupport instance specifies a non-null set of legal values for the described attribute, false otherwise. |
boolean |
hasMaxValue()
Returns true if this OpenMBeanAttributeInfoSupport instance specifies a non-null maximal value for the described attribute, false otherwise. |
boolean |
hasMinValue()
Returns true if this OpenMBeanAttributeInfoSupport instance specifies a non-null minimal value for the described attribute, false otherwise. |
boolean |
isValue(java.lang.Object obj)
Tests whether obj is a valid value for the attribute described by this OpenMBeanAttributeInfoSupport
instance. |
java.lang.String |
toString()
Returns a string representation of this OpenMBeanAttributeInfoSupport instance.
|
| Methods inherited from class javax.management.MBeanAttributeInfo |
clone, getType, isIs, isReadable, isWritable |
| Methods inherited from class javax.management.MBeanFeatureInfo |
getDescription, getName |
| Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface javax.management.openmbean.OpenMBeanAttributeInfo |
isIs, isReadable, isWritable |
| Methods inherited from interface javax.management.openmbean.OpenMBeanParameterInfo |
getDescription, getName |
| Constructor Detail |
public OpenMBeanAttributeInfoSupport(java.lang.String name,
java.lang.String description,
OpenType openType,
boolean isReadable,
boolean isWritable,
boolean isIs)
name - cannot be a null or empty string.description - cannot be a null or empty string.openType - cannot be null.isReadable - true if the attribute has a getter exposed for management.isWritable - true if the attribute has a setter exposed for management.isIs - true if the attribute's getter is of the form isXXX.
java.lang.IllegalArgumentException - if name or description are null or empty string,
or openType is null.
public OpenMBeanAttributeInfoSupport(java.lang.String name,
java.lang.String description,
OpenType openType,
boolean isReadable,
boolean isWritable,
boolean isIs,
java.lang.Object defaultValue)
throws OpenDataException
name - cannot be a null or empty string.description - cannot be a null or empty string.openType - cannot be null.isReadable - true if the attribute has a getter exposed for management.isWritable - true if the attribute has a setter exposed for management.isIs - true if the attribute's getter is of the form isXXX.defaultValue - must be a valid value for the openType specified for this attribute;
default value not supported for ArrayType and TabularType;
can be null, in which case it means that no default value is set.
java.lang.IllegalArgumentException - if name or description are null or empty string,
or openType is null.
OpenDataException - if defaultValue is not a valid value for the specified openType,
or defaultValue is non null and
openType is an ArrayType or a TabularType.
public OpenMBeanAttributeInfoSupport(java.lang.String name,
java.lang.String description,
OpenType openType,
boolean isReadable,
boolean isWritable,
boolean isIs,
java.lang.Object defaultValue,
java.lang.Object[] legalValues)
throws OpenDataException
name - cannot be a null or empty string.description - cannot be a null or empty string.openType - cannot be null.isReadable - true if the attribute has a getter exposed for management.isWritable - true if the attribute has a setter exposed for management.isIs - true if the attribute's getter is of the form isXXX.defaultValue - must be a valid value for the openType specified for this attribute;
default value not supported for ArrayType and TabularType;
can be null, in which case it means that no default value is set.legalValues - each contained value must be valid for the openType specified for this attribute;
legal values not supported for ArrayType and TabularType;
can be null or empty.
java.lang.IllegalArgumentException - if name or description are null or empty string,
or openType is null.
OpenDataException - if defaultValue is not a valid value for the specified openType,
or one value in legalValues is not valid for the specified openType,
or defaultValue is non null and
openType is an ArrayType or a TabularType,
or legalValues is non null and non empty and
openType is an ArrayType or a TabularType,
or legalValues is non null and non empty and
defaultValue is not contained in legalValues.
public OpenMBeanAttributeInfoSupport(java.lang.String name,
java.lang.String description,
OpenType openType,
boolean isReadable,
boolean isWritable,
boolean isIs,
java.lang.Object defaultValue,
java.lang.Comparable minValue,
java.lang.Comparable maxValue)
throws OpenDataException
name - cannot be a null or empty string.description - cannot be a null or empty string.openType - cannot be null.isReadable - true if the attribute has a getter exposed for management.isWritable - true if the attribute has a setter exposed for management.isIs - true if the attribute's getter is of the form isXXX.defaultValue - must be a valid value for the openType specified for this attribute;
default value not supported for ArrayType and TabularType;
can be null, in which case it means that no default value is set.minValue - must be valid for the openType specified for this attribute;
can be null, in which case it means that no minimal value is set.maxValue - must be valid for the openType specified for this attribute;
can be null, in which case it means that no maximal value is set.
java.lang.IllegalArgumentException - if name or description are null or empty string,
or openType is null.
OpenDataException - if defaultValue, minValue or maxValue
is not a valid value for the specified openType,
or defaultValue is non null and
openType is an ArrayType or a TabularType,
or both minValue and maxValue are non-null and
minValue.compareTo(maxValue) > 0 is true,
or both defaultValue and minValue are non-null and
minValue.compareTo(defaultValue) > 0 is true,
or both defaultValue and maxValue are non-null and
defaultValue.compareTo(maxValue) > 0 is true.| Method Detail |
public OpenType getOpenType()
getOpenType in interface OpenMBeanParameterInfopublic java.lang.Object getDefaultValue()
getDefaultValue in interface OpenMBeanParameterInfopublic java.util.Set getLegalValues()
getLegalValues in interface OpenMBeanParameterInfopublic java.lang.Comparable getMinValue()
getMinValue in interface OpenMBeanParameterInfopublic java.lang.Comparable getMaxValue()
getMaxValue in interface OpenMBeanParameterInfopublic boolean hasDefaultValue()
hasDefaultValue in interface OpenMBeanParameterInfopublic boolean hasLegalValues()
hasLegalValues in interface OpenMBeanParameterInfopublic boolean hasMinValue()
hasMinValue in interface OpenMBeanParameterInfopublic boolean hasMaxValue()
hasMaxValue in interface OpenMBeanParameterInfopublic boolean isValue(java.lang.Object obj)
OpenMBeanAttributeInfoSupport
instance.
isValue in interface OpenMBeanParameterInfoobj - the object to be tested.
true if obj is a valid value for for the parameter described by
this OpenMBeanAttributeInfoSupport instance, false otherwise.public boolean equals(java.lang.Object obj)
OpenMBeanAttributeInfoSupport instance for equality.
Returns true if and only if all of the following statements are true:
OpenMBeanAttributeInfo interface,OpenMBeanAttributeInfo interface.
equals in interface OpenMBeanAttributeInfoequals in class MBeanAttributeInfoobj - the object to be compared for equality with this OpenMBeanAttributeInfoSupport instance;
true if the specified object is equal to this OpenMBeanAttributeInfoSupport instance.public int hashCode()
OpenMBeanAttributeInfoSupport instance.
The hash code of an OpenMBeanAttributeInfoSupport instance is the sum of the hash codes
of all elements of information used in equals comparisons
(ie: its name, its open type, and its default, min, max and legal values).
This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode()
for any two OpenMBeanAttributeInfoSupport instances t1 and t2,
as required by the general contract of the method
Object.hashCode().
However, note that another instance of a class implementing the OpenMBeanAttributeInfo interface
may be equal to this OpenMBeanAttributeInfoSupport instance as defined by equals(java.lang.Object),
but may have a different hash code if it is calculated differently.
As OpenMBeanAttributeInfoSupport instances are immutable, the hash code for this instance is calculated once,
on the first call to hashCode, and then the same value is returned for subsequent calls.
hashCode in interface OpenMBeanAttributeInfohashCode in class MBeanAttributeInfoOpenMBeanAttributeInfoSupport instancepublic java.lang.String toString()
OpenMBeanAttributeInfoSupport instance.
The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanAttributeInfoSupport),
the string representation of the name and open type of the described parameter,
and the string representation of its default, min, max and legal values.
As OpenMBeanAttributeInfoSupport instances are immutable, the string representation for this instance is calculated once,
on the first call to toString, and then the same value is returned for subsequent calls.
toString in interface OpenMBeanAttributeInfoOpenMBeanAttributeInfoSupport instance
|
J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.