javax.management.openmbean.OpenMBeanAttributeInfo Maven / Gradle / Ivy
The newest version!
/**
* Copyright (C) The MX4J Contributors.
* All rights reserved.
*
* This software is distributed under the terms of the MX4J License version 1.0.
* See the terms of the MX4J License in the documentation provided with this software.
*/
package javax.management.openmbean;
/**
* An OpenMBeanAttributeInfo represents an attribute of
* an OpenMBean
*
* @version $Revision: 1.4 $
* @see OpenMBeanAttributeInfoSupport
*/
public interface OpenMBeanAttributeInfo extends OpenMBeanParameterInfo
{
/**
* Returns true if the attribute is readable, false in not.
*
* @return boolean true of readable
*/
public boolean isReadable();
/**
* Returns true if the attribute is writable, false in not.
*
* @return boolean true of writable
*/
public boolean isWritable();
/**
* Returns true if the attribute described is accessed through a isXXX
* getter
*
*
* Note: applies only to boolean and Boolean values
*
*
* @return boolean true if accessed through a isXXX
*/
public boolean isIs();
/**
* Compares the give Object for equality with this instance.
*
*
* The operation returns true if and only if the following statements
* are all true:
*
* - obj is not null
* - obj also implements OpenMBeanAttributeInfo
* - their names are equals
* - their open types are equal
* - access properties (isReadable, isWritable, isIs) are equal
* - default,min,max and legal values are equal
*
*
* @return boolean true if the above conditions are met
*/
public boolean equals(Object obj);
/**
* Computes the hashCode of this OpenMBeanAttributeInfo
*
* @return int The hashCode value
*/
public int hashCode();
/**
* Returns a string representation of this OpenMBeanAttributeInfo instance.
*
* @return String The representation as string
*/
public String toString();
}