|
|||||||||
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
public class OpenMBeanAttributeInfoSupport
Describes an attribute of an open management bean.
Field Summary |
---|
Fields inherited from class javax.management.MBeanFeatureInfo |
---|
description, name |
Constructor Summary | |
---|---|
OpenMBeanAttributeInfoSupport(String name,
String desc,
OpenType<?> type,
boolean isReadable,
boolean isWritable,
boolean isIs)
Constructs a new OpenMBeanAttributeInfo using the
specified name, description, open type and access properties. |
|
OpenMBeanAttributeInfoSupport(String name,
String desc,
OpenType<T> type,
boolean isReadable,
boolean isWritable,
boolean isIs,
T defaultValue)
Constructs a new OpenMBeanAttributeInfo using the
specified name, description, open type and default value. |
|
OpenMBeanAttributeInfoSupport(String name,
String desc,
OpenType<T> type,
boolean isReadable,
boolean isWritable,
boolean isIs,
T defaultValue,
Comparable<T> minimumValue,
Comparable<T> maximumValue)
Constructs a new OpenMBeanAttributeInfo using the
specified name, description, open type, access properties,
default, maximum and minimum values. |
|
OpenMBeanAttributeInfoSupport(String name,
String desc,
OpenType<T> type,
boolean isReadable,
boolean isWritable,
boolean isIs,
T defaultValue,
T[] legalValues)
Constructs a new OpenMBeanAttributeInfo using the
specified name, description, open type, access properties, default
value and set of legal values. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
Compares this attribute with the supplied object. |
Object |
getDefaultValue()
Returns the default value of this attribute, or null
if there is no default value. |
Set<?> |
getLegalValues()
Returns a Set enumerating the legal values
of this attribute, or null if no such limited
set exists for this attribute. |
Comparable<?> |
getMaxValue()
Returns the maximum value of this attribute, or null
if there is no maximum. |
Comparable<?> |
getMinValue()
Returns the minimum value of this attribute, or null
if there is no minimum. |
OpenType<?> |
getOpenType()
Returns the open type instance which represents the type of this attribute. |
boolean |
hasDefaultValue()
Returns true if this attribute has a default value (i.e. the value is non-null). |
int |
hashCode()
Returns the hashcode of the attribute information as the sum of the hashcodes of the name, open type, default value, maximum value, minimum value and the set of legal values. |
boolean |
hasLegalValues()
Returns true if there is a set of legal values for this attribute (i.e. the value is non-null). |
boolean |
hasMaxValue()
Returns true if there is a maximum value for this attribute (i.e. the value is non-null). |
boolean |
hasMinValue()
Returns true if there is a minimum value for this attribute. |
boolean |
isValue(Object obj)
Returns true if the specified object is a valid value for this attribute. |
String |
toString()
Returns a textual representation of this 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(String name, String desc, OpenType<?> type, boolean isReadable, boolean isWritable, boolean isIs)
OpenMBeanAttributeInfo
using the
specified name, description, open type and access properties.
The name, description and open type may not be null
and the name and description may not be equal to the empty
string.
name
- the name of the attribute.desc
- a description of the attribute.type
- the open type of the attribute.isReadable
- true if the attribute's value can be read.isWritable
- true if the attribute's value can be changed.isIs
- true if the attribute uses an accessor of the form isXXX.
IllegalArgumentException
- if the name, description or
open type are null
or the name or description are
the empty string.public OpenMBeanAttributeInfoSupport(String name, String desc, OpenType<T> type, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue) throws OpenDataException
OpenMBeanAttributeInfo
using the
specified name, description, open type and default value. The
name, description and open type cannot be null
and
the name and description may not be equal to the empty string.
The default value may be null
. If non-null, it must
be a valid value of the given open type. Default values are not
applicable to the open types, ArrayType
and TabularType
.
name
- the name of the attribute.desc
- a description of the attribute.type
- the open type of the attribute.isReadable
- true if the attribute's value can be read.isWritable
- true if the attribute's value can be changed.isIs
- true if the attribute uses an accessor of the form isXXX.defaultValue
- the default value of the attribute.
IllegalArgumentException
- if the name, description or
open type are null
or the name or description are
the empty string.
OpenDataException
- if defaultValue is non-null
and is either not a value of the given
open type or the open type is an instance
of ArrayType
or TabularType
.
public OpenMBeanAttributeInfoSupport(String name, String desc, OpenType<T> type, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, Comparable<T> minimumValue, Comparable<T> maximumValue) throws OpenDataException
Constructs a new OpenMBeanAttributeInfo
using the
specified name, description, open type, access properties,
default, maximum and minimum values. The name, description
and open type cannot be null
and the name and
description may not be equal to the empty string. The
default, maximum and minimum values may be null
.
The following conditions apply when the attributes mentioned
are non-null:
ArrayType
and TabularType
.minValue.compareTo(maxValue) <= 0
.minValue.compareTo(defaultValue) <= 0
.defaultValue.compareTo(maxValue) <= 0
.
name
- the name of the attribute.desc
- a description of the attribute.type
- the open type of the attribute.isReadable
- true if the attribute's value can be read.isWritable
- true if the attribute's value can be changed.isIs
- true if the attribute uses an accessor of the form isXXX.defaultValue
- the default value of the attribute, or null
.minimumValue
- the minimum value of the attribute, or null
.maximumValue
- the maximum value of the attribute, or null
.
IllegalArgumentException
- if the name, description or
open type are null
or the name or description are
the empty string.
OpenDataException
- if any condition in the list above is broken.public OpenMBeanAttributeInfoSupport(String name, String desc, OpenType<T> type, boolean isReadable, boolean isWritable, boolean isIs, T defaultValue, T[] legalValues) throws OpenDataException
Constructs a new OpenMBeanAttributeInfo
using the
specified name, description, open type, access properties, default
value and set of legal values. The name, description and open type
cannot be null
and the name and description may not be
equal to the empty string. The default, maximum and minimum values
may be null
. The following conditions apply when the
attributes mentioned are non-null:
ArrayType
and TabularType
.The legal values are copied from the array into a unmodifiable set, so future modifications to the array have no effect.
name
- the name of the attribute.desc
- a description of the attribute.type
- the open type of the attribute.isReadable
- true if the attribute's value can be read.isWritable
- true if the attribute's value can be changed.isIs
- true if the attribute uses an accessor of the form isXXX.defaultValue
- the default value of the attribute, or null
.legalValues
- the legal values of the attribute. May be
null
or an empty array.
IllegalArgumentException
- if the name, description or
open type are null
or the name or description are
the empty string.
OpenDataException
- if any condition in the list above is broken.Method Detail |
---|
public boolean equals(Object obj)
OpenMBeanAttributeInfo
with an equal name and open type and the same default, minimum,
maximum and legal values and the same access properties.
equals
in interface OpenMBeanAttributeInfo
equals
in interface OpenMBeanParameterInfo
equals
in class MBeanAttributeInfo
obj
- the object to compare.
OpenMBeanAttributeInfo
instance,
name.equals(object.getName())
,
openType.equals(object.getOpenType())
,
isRead == object.isReadable()
,
isWrite == object.isWritable()
,
isIs == object.isIs()
,
defaultValue.equals(object.getDefaultValue())
,
minValue.equals(object.getMinValue())
,
maxValue.equals(object.getMaxValue())
,
and legalValues.equals(object.getLegalValues())
.Object.hashCode()
public Object getDefaultValue()
null
if there is no default value.
getDefaultValue
in interface OpenMBeanParameterInfo
null
if there is no default.public Set<?> getLegalValues()
Set
enumerating the legal values
of this attribute, or null
if no such limited
set exists for this attribute.
getLegalValues
in interface OpenMBeanParameterInfo
null
if no such
set exists.public Comparable<?> getMaxValue()
null
if there is no maximum.
getMaxValue
in interface OpenMBeanParameterInfo
null
if none exists.public Comparable<?> getMinValue()
null
if there is no minimum.
getMinValue
in interface OpenMBeanParameterInfo
null
if none exists.public OpenType<?> getOpenType()
getOpenType
in interface OpenMBeanParameterInfo
public boolean hasDefaultValue()
hasDefaultValue
in interface OpenMBeanParameterInfo
public int hashCode()
Returns the hashcode of the attribute information as the sum of the hashcodes of the name, open type, default value, maximum value, minimum value and the set of legal values.
As instances of this class are immutable, the hash code is computed just once for each instance and reused throughout its life.
hashCode
in interface OpenMBeanAttributeInfo
hashCode
in interface OpenMBeanParameterInfo
hashCode
in class MBeanAttributeInfo
Object.equals(Object)
,
System.identityHashCode(Object)
public boolean hasLegalValues()
hasLegalValues
in interface OpenMBeanParameterInfo
public boolean hasMaxValue()
hasMaxValue
in interface OpenMBeanParameterInfo
public boolean hasMinValue()
hasMinValue
in interface OpenMBeanParameterInfo
public boolean isValue(Object obj)
isValue
in interface OpenMBeanParameterInfo
obj
- the object to test.
obj
is a valid value for this
attribute.public String toString()
Returns a textual representation of this instance. This
is constructed using the class name
(javax.management.openmbean.OpenMBeanAttributeInfo
)
along with the name, open type, access properties, default,
minimum, maximum and legal values of the attribute.
As instances of this class are immutable, the return value is computed just once for each instance and reused throughout its life.
toString
in interface OpenMBeanAttributeInfo
toString
in interface OpenMBeanParameterInfo
toString
in class MBeanAttributeInfo
Object.getClass()
,
Object.hashCode()
,
Class.getName()
,
Integer.toHexString(int)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |