|
Préférences
Moteurs de recherche
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JavaTM 2 Platform Std. Ed. v1.6.0
javax.management
|
Name | Type | Used in | Meaning |
---|---|---|---|
defaultValue | Object | MBeanAttributeInfo MBeanParameterInfo |
Default value for an attribute or parameter. See
javax.management.openmbean . |
deprecated | String | Any | An indication that this element of the information model is no
longer recommended for use. A set of MBeans defined by an
application is collectively called an information model.
The convention is for the value of this field to contain a string
that is the version of the model in which the element was first
deprecated, followed by a space, followed by an explanation of the
deprecation, for example "1.3 Replaced by the Capacity
attribute" . |
descriptionResource BundleBaseName | String | Any | The base name for the ResourceBundle in which the key given in
the descriptionResourceKey field can be found, for example
"com.example.myapp.MBeanResources" . The meaning of this
field is defined by this specification but the field is not set or
used by the JMX API itself. |
descriptionResourceKey | String | Any | A resource key for the description of this element. In
conjunction with the descriptionResourceBundleBaseName ,
this can be used to find a localized version of the description.
The meaning of this field is defined by this specification but the
field is not set or used by the JMX API itself. |
enabled | String | MBeanAttributeInfo MBeanNotificationInfo MBeanOperationInfo |
The string "true" or "false" according as this
item is enabled. When an attribute or operation is not enabled, it
exists but cannot currently be accessed. A user interface might
present it as a greyed-out item. For example, an attribute might
only be meaningful after the start() method of an MBean has
been called, and is otherwise disabled. Likewise, a notification
might be disabled if it cannot currently be emitted but could be in
other circumstances. |
immutableInfo | String | MBeanInfo | The string "true" or "false" according as this
MBean's MBeanInfo is immutable. When this field is true,
the MBeanInfo for the given MBean is guaranteed not to change over
the lifetime of the MBean. Hence, a client can read it once and
cache the read value. When this field is false or absent, there is
no such guarantee, although that does not mean that the MBeanInfo
will necessarily change. |
infoTimeout | String Long | MBeanInfo | The time in milli-seconds that the MBeanInfo can reasonably be
expected to be unchanged. The value can be a Long or a
decimal string. This provides a hint from a DynamicMBean or any
MBean that does not define immutableInfo as true
that the MBeanInfo is not likely to change within this period and
therefore can be cached. When this field is missing or has the
value zero, it is not recommended to cache the MBeanInfo unless it
has the immutableInfo set to true . |
interfaceClassName | String | MBeanInfo | The Java interface name for a Standard MBean or MXBean, as
returned by Class.getName() . A Standard MBean or MXBean
registered directly in the MBean Server or created using the StandardMBean class will have this field in its MBeanInfo
Descriptor. |
legalValues | Set<?> | MBeanAttributeInfo MBeanParameterInfo |
Legal values for an attribute or parameter. See
javax.management.openmbean . |
maxValue | Object | MBeanAttributeInfo MBeanParameterInfo |
Maximum legal value for an attribute or parameter. See
javax.management.openmbean . |
metricType | String | MBeanAttributeInfo MBeanOperationInfo |
The type of a metric, one of the strings "counter" or "gauge". A metric is a measurement exported by an MBean, usually an attribute but sometimes the result of an operation. A metric that is a counter has a value that never decreases except by being reset to a starting value. Counter metrics are almost always non-negative integers. An example might be the number of requests received. A metric that is a gauge has a numeric value that can increase or decrease. Examples might be the number of open connections or a cache hit rate or a temperature reading. |
minValue | Object | MBeanAttributeInfo MBeanParameterInfo |
Minimum legal value for an attribute or parameter. See
javax.management.openmbean . |
mxbean | String | MBeanInfo | The string "true" or "false" according as this
MBean is an MXBean . A Standard MBean or MXBean registered
directly with the MBean Server or created using the StandardMBean class will have this field in its MBeanInfo
Descriptor. |
openType | OpenType |
MBeanAttributeInfo MBeanOperationInfo MBeanParameterInfo |
The Open Type of this element. In the case of This field can be set for an |
originalType | String | MBeanAttributeInfo MBeanOperationInfo MBeanParameterInfo |
The original Java type of this element as it appeared in the
The format of this string is described in the section Type Names of the MXBean specification. |
severity | String Integer |
MBeanNotificationInfo | The severity of this notification. It can be 0 to mean
unknown severity or a value from 1 to 6 representing decreasing
levels of severity. It can be represented as a decimal string or
an Integer . |
since | String | Any | The version of the information model in which this element
was introduced. A set of MBeans defined by an application is
collectively called an information model. The
application may also define versions of this model, and use the
"since" field to record the version in which an element
first appeared. |
units | String | MBeanAttributeInfo MBeanParameterInfo MBeanOperationInfo |
The units in which an attribute, parameter, or operation return
value is measured, for example "bytes" or "seconds" . |
Some additional fields are defined by Model MBeans. See
ModelMBeanInfo
and related classes and the chapter "Model MBeans" of the
JMX Specification.
Method Summary | |
---|---|
Object |
clone()
Returns a descriptor which is equal to this descriptor. |
boolean |
equals(Object obj)
Compares this descriptor to the given object. |
String[] |
getFieldNames()
Returns all the field names in the descriptor. |
String[] |
getFields()
Returns all of the fields contained in this descriptor as a string array. |
Object |
getFieldValue(String fieldName)
Returns the value for a specific field name, or null if no value is present for that name. |
Object[] |
getFieldValues(String... fieldNames)
Returns all the field values in the descriptor as an array of Objects. |
int |
hashCode()
Returns the hash code value for this descriptor. |
boolean |
isValid()
Returns true if all of the fields have legal values given their names. |
void |
removeField(String fieldName)
Removes a field from the descriptor. |
void |
setField(String fieldName,
Object fieldValue)
Sets the value for a specific field name. |
void |
setFields(String[] fieldNames,
Object[] fieldValues)
Sets all fields in the field names array to the new value with the same index in the field values array. |
Method Detail |
---|
Object getFieldValue(String fieldName) throws RuntimeOperationsException
fieldName
- the field name.
RuntimeOperationsException
- if the field name is illegal.void setField(String fieldName, Object fieldValue) throws RuntimeOperationsException
Sets the value for a specific field name. This will modify an existing field or add a new field.
The field value will be validated before it is set. If it is not valid, then an exception will be thrown. The meaning of validity is dependent on the descriptor implementation.
fieldName
- The field name to be set. Cannot be null or empty.fieldValue
- The field value to be set for the field
name. Can be null if that is a valid value for the field.
RuntimeOperationsException
- if the field name or field value
is illegal (wrapped exception is IllegalArgumentException
); or
if the descriptor is immutable (wrapped exception is
UnsupportedOperationException
).String[] getFields()
setFields(java.lang.String[], java.lang.Object[])
String[] getFieldNames()
Object[] getFieldValues(String... fieldNames)
fieldNames
String array parameter.
fieldNames
- String array of the names of the fields that
the values should be returned for. If the array is empty then
an empty array will be returned. If the array is null then all
values will be returned, as if the parameter were the array
returned by getFieldNames()
. If a field name in the
array does not exist, including the case where it is null or
the empty string, then null is returned for the matching array
element being returned.
fieldNames
is empty, you will get an empty array.void removeField(String fieldName)
fieldName
- String name of the field to be removed.
If the field name is illegal or the field is not found,
no exception is thrown.
RuntimeOperationsException
- if a field of the given name
exists and the descriptor is immutable. The wrapped exception will
be an UnsupportedOperationException
.void setFields(String[] fieldNames, Object[] fieldValues) throws RuntimeOperationsException
Sets all fields in the field names array to the new value with the same index in the field values array. Array sizes must match.
The field value will be validated before it is set. If it is not valid, then an exception will be thrown. If the arrays are empty, then no change will take effect.
fieldNames
- String array of field names. The array and array
elements cannot be null.fieldValues
- Object array of the corresponding field values.
The array cannot be null. Elements of the array can be null.
RuntimeOperationsException
- if the change fails for any reason.
Wrapped exception is IllegalArgumentException
if
fieldNames
or fieldValues
is null, or if
the arrays are of different lengths, or if there is an
illegal value in one of them.
Wrapped exception is UnsupportedOperationException
if the descriptor is immutable, and the call would change
its contents.getFields()
Object clone() throws RuntimeOperationsException
Returns a descriptor which is equal to this descriptor. Changes to the returned descriptor will have no effect on this descriptor, and vice versa. If this descriptor is immutable, it may fulfill this condition by returning itself.
RuntimeOperationsException
- for illegal value for field names
or field values.
If the descriptor construction fails for any reason, this exception will
be thrown.boolean isValid() throws RuntimeOperationsException
RuntimeOperationsException
- If the validity checking fails for
any reason, this exception will be thrown.
The method returns false if the descriptor is not valid, but throws
this exception if the attempt to determine validity fails.boolean equals(Object obj)
Arrays.deepEquals(Object[],Object[])
must return true.Object.equals(Object)
must return true.
obj
- the object to compare with.
true
if the objects are the same; false
otherwise.Object.hashCode()
,
Hashtable
int hashCode()
Returns the hash code value for this descriptor. The hash
code is computed as the sum of the hash codes for each field in
the descriptor. The hash code of a field with name n
and value v
is n.toLowerCase().hashCode() ^ h
.
Here h
is the hash code of v
, computed as
follows:
v
is null then h
is 0.v
is a primitive array then h
is computed using
the appropriate overloading of java.util.Arrays.hashCode
.v
is an object array then h
is computed using
Arrays.deepHashCode(Object[])
.h
is v.hashCode()
.
Object.equals(java.lang.Object)
,
Hashtable