Source for javax.management.openmbean.OpenMBeanAttributeInfo

   1: /* OpenMBeanAttributeInfo.java -- Open typed info about an attribute.
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.management.openmbean;
  39: 
  40: /**
  41:  * Describes an attribute associated with an open management bean.
  42:  * This interface includes those methods specified by {@link
  43:  * javax.management.MBeanAttributeInfo}, so implementations should
  44:  * extend this class.
  45:  *
  46:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  47:  * @since 1.5
  48:  */
  49: public interface OpenMBeanAttributeInfo
  50:   extends OpenMBeanParameterInfo
  51: {
  52: 
  53:   /**
  54:    * Compares this attribute with the supplied object.  This returns
  55:    * true iff the object is an instance of {@link OpenMBeanAttributeInfo}
  56:    * with an equal name and open type, the same default, minimum,
  57:    * maximum and legal values and the same access properties
  58:    * ({@link #isIs()}, {@link #isReadable()}, {@link #isWritable()}).
  59:    *
  60:    * @param obj the object to compare.
  61:    * @return true if the object is a {@link OpenMBeanParameterInfo}
  62:    *         instance, 
  63:    *         <code>name.equals(object.getName())</code>,
  64:    *         <code>openType.equals(object.getOpenType())</code>,
  65:    *         <code>defaultValue.equals(object.getDefaultValue())</code>,
  66:    *         <code>minValue.equals(object.getMinValue())</code>,
  67:    *         <code>maxValue.equals(object.getMaxValue())</code>,
  68:    *         <code>legalValues.equals(object.getLegalValues())</code>,
  69:    *         <code>is == object.isIs()</code>,
  70:    *         <code>isRead == object.isReadable()</code>,
  71:    *         and <code>isWrite == object.isWritable()</code>.
  72:    */
  73:   boolean equals(Object obj);
  74: 
  75:   /**
  76:    * Returns the hashcode of the attribute information as the sum of
  77:    * the hashcodes of the name, open type, default value, maximum
  78:    * value, minimum value, the set of legal values and the access
  79:    * properties.
  80:    *
  81:    * @return the hashcode of the attribute information.
  82:    */
  83:   int hashCode();
  84: 
  85:   /**
  86:    * Returns true if the accessor method of this attribute
  87:    * is of the form <code>isXXX</code>.
  88:    *
  89:    * @return true if the accessor takes the form <code>isXXX</code>.
  90:    */
  91:   boolean isIs();
  92: 
  93:   /**
  94:    * Returns true if value of this attribute can be read.
  95:    *
  96:    * @return true if the value of the attribute can be read.
  97:    */
  98:   boolean isReadable();
  99: 
 100:   /**
 101:    * Returns true if the value of this attribute can be changed.
 102:    *
 103:    * @return true if the value of the attribute can be changed.
 104:    */
 105:   boolean isWritable();
 106: 
 107:   /**
 108:    * Returns a textual representation of this instance.  This
 109:    * is constructed using the class name
 110:    * (<code>javax.management.openmbean.OpenMBeanAttributeInfo</code>)
 111:    * along with the name, open type, default, minimum, maximum
 112:    * and legal values of the parameter and the access permissions
 113:    * ({@link #isIs()}, {@link #isReadable()}, {@link #isWritable()}).
 114:    *
 115:    * @return a @link{java.lang.String} instance representing
 116:    *         the instance in textual form.
 117:    */
 118:   String toString();
 119: 
 120: }