OpenMBeanAttributeInfo (Java SE 15 & JDK 15) (original) (raw)
All Superinterfaces:
[OpenMBeanParameterInfo](OpenMBeanParameterInfo.html "interface in javax.management.openmbean")
All Known Implementing Classes:
[OpenMBeanAttributeInfoSupport](OpenMBeanAttributeInfoSupport.html "class in javax.management.openmbean")
public interface OpenMBeanAttributeInfo extends OpenMBeanParameterInfo
Since:
1.5
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | equals(Object obj) | Compares the specified obj parameter with thisOpenMBeanAttributeInfo instance for equality. |
int | hashCode() | Returns the hash code value for this OpenMBeanAttributeInfo instance. |
boolean | isIs() | Returns true if the attribute described by this OpenMBeanAttributeInfo instance is accessed through a is_XXX_ getter (applies only to boolean and Boolean values),false otherwise. |
boolean | isReadable() | Returns true if the attribute described by this OpenMBeanAttributeInfo instance is readable, false otherwise. |
boolean | isWritable() | Returns true if the attribute described by this OpenMBeanAttributeInfo instance is writable, false otherwise. |
String | toString() | Returns a string representation of this OpenMBeanAttributeInfo instance. |
Methods declared in interface javax.management.openmbean.OpenMBeanParameterInfo
[getDefaultValue](OpenMBeanParameterInfo.html#getDefaultValue%28%29), [getDescription](OpenMBeanParameterInfo.html#getDescription%28%29), [getLegalValues](OpenMBeanParameterInfo.html#getLegalValues%28%29), [getMaxValue](OpenMBeanParameterInfo.html#getMaxValue%28%29), [getMinValue](OpenMBeanParameterInfo.html#getMinValue%28%29), [getName](OpenMBeanParameterInfo.html#getName%28%29), [getOpenType](OpenMBeanParameterInfo.html#getOpenType%28%29), [hasDefaultValue](OpenMBeanParameterInfo.html#hasDefaultValue%28%29), [hasLegalValues](OpenMBeanParameterInfo.html#hasLegalValues%28%29), [hasMaxValue](OpenMBeanParameterInfo.html#hasMaxValue%28%29), [hasMinValue](OpenMBeanParameterInfo.html#hasMinValue%28%29), [isValue](OpenMBeanParameterInfo.html#isValue%28java.lang.Object%29)
Method Details
isReadable
boolean isReadable()
Returnstrue
if the attribute described by thisOpenMBeanAttributeInfo
instance is readable,false
otherwise.
Returns:
true if the attribute is readable.isWritable
boolean isWritable()
Returnstrue
if the attribute described by thisOpenMBeanAttributeInfo
instance is writable,false
otherwise.
Returns:
true if the attribute is writable.isIs
boolean isIs()
Returnstrue
if the attribute described by thisOpenMBeanAttributeInfo
instance is accessed through ais_XXX_
getter (applies only toboolean
andBoolean
values),false
otherwise.
Returns:
true if the attribute is accessed throughis_XXX_
.equals
boolean equals(Object obj)
Compares the specified obj parameter with thisOpenMBeanAttributeInfo
instance for equality.
Returnstrue
if and only if all of the following statements are true:
* obj is non null,
* obj also implements theOpenMBeanAttributeInfo
interface,
* 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.
This ensures that thisequals
method works properly for obj parameters which are different implementations of theOpenMBeanAttributeInfo
interface.
Specified by:
[equals](OpenMBeanParameterInfo.html#equals%28java.lang.Object%29)
in interface[OpenMBeanParameterInfo](OpenMBeanParameterInfo.html "interface in javax.management.openmbean")
Overrides:
[equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29)
in class[Object](../../../../java.base/java/lang/Object.html "class in java.lang")
Parameters:
obj
- the object to be compared for equality with thisOpenMBeanAttributeInfo
instance;
Returns:
true
if the specified object is equal to thisOpenMBeanAttributeInfo
instance.
See Also:
Object.hashCode(), HashMaphashCode
int hashCode()
Returns the hash code value for thisOpenMBeanAttributeInfo
instance.
The hash code of anOpenMBeanAttributeInfo
instance is the sum of the hash codes of all elements of information used inequals
comparisons (ie: its name, its open type, and its default, min, max and legal values).
This ensures thatt1.equals(t2)
implies thatt1.hashCode()==t2.hashCode()
for any twoOpenMBeanAttributeInfo
instancest1
andt2
, as required by the general contract of the methodObject.hashCode().
Specified by:
[hashCode](OpenMBeanParameterInfo.html#hashCode%28%29)
in interface[OpenMBeanParameterInfo](OpenMBeanParameterInfo.html "interface in javax.management.openmbean")
Overrides:
[hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29)
in class[Object](../../../../java.base/java/lang/Object.html "class in java.lang")
Returns:
the hash code value for thisOpenMBeanAttributeInfo
instance
See Also:
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)toString
Returns a string representation of this
OpenMBeanAttributeInfo
instance.
The string representation consists of the name of this class (iejavax.management.openmbean.OpenMBeanAttributeInfo
), the string representation of the name and open type of the described attribute, and the string representation of its default, min, max and legal values.
Specified by:
[toString](OpenMBeanParameterInfo.html#toString%28%29)
in interface[OpenMBeanParameterInfo](OpenMBeanParameterInfo.html "interface in javax.management.openmbean")
Overrides:
[toString](../../../../java.base/java/lang/Object.html#toString%28%29)
in class[Object](../../../../java.base/java/lang/Object.html "class in java.lang")
Returns:
a string representation of thisOpenMBeanAttributeInfo
instance