libjava/classpath/javax/management/ObjectInstance.java

   1 /* ObjectInstance.java -- Represent the bean instance used by a server.
   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;
  39
  40 import java.io.Serializable;
  41
  42 /**
  43  * A simple class used to link a bean instance to its class name.
  44  * If the bean is a {@link DynamicMBean}, the class name may be
  45  * obtained using {@link MBeanInfo#getClassName()}.
  46  *
  47  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  48  * @since 1.5
  49  */
  50 public class ObjectInstance
  51   implements Serializable
  52 {
  53
  54   /**
  55    * Compatible with JDK 1.5
  56    */
  57   private static final long serialVersionUID = -4099952623687795850L;
  58
  59   /**
  60    * The name of the bean.
  61    */
  62   private ObjectName name;
  63
  64   /**
  65    * The class name of the bean.
  66    */
  67   private String className;
  68
  69   /**
  70    * Constructs a new {@link ObjectInstance} for the specified bean
  71    * with the supplied class name.  The class name should include
  72    * the full package name.
  73    *
  74    * @param name the name of the bean.
  75    * @param className the class name of the bean.
  76    */
  77   public ObjectInstance(ObjectName name, String className)
  78   {
  79     this.name = name;
  80     this.className = className;
  81   }
  82
  83   /**
  84    * Constructs a new {@link ObjectInstance} for the specified bean
  85    * with the supplied class name.  The class name should include
  86    * the full package name.
  87    *
  88    * @param name the name of the bean.
  89    * @param className the class name of the bean.
  90    * @throws MalformedObjectNameException if the name of the bean
  91    *                                      does not match the syntax
  92    *                                      of an {@link ObjectName}.
  93    */
  94   public ObjectInstance(String name, String className)
  95     throws MalformedObjectNameException
  96   {
  97     this(new ObjectName(name), className);
  98   }
  99
 100   /**
 101    * Returns true if the supplied object is also an {@link ObjectInstance}
 102    * with the same bean and class name.
 103    *
 104    * @param obj the object to compare.
 105    * @return true if the the supplied object is equal to <code>this</code>.
 106    */
 107   public boolean equals(Object obj)
 108   {
 109     if (!(obj instanceof ObjectInstance))
 110       return false;
 111     ObjectInstance i = (ObjectInstance) obj;
 112     return (i.getClassName().equals(className) &&
 113             i.getObjectName().equals(name));
 114   }
 115
 116   /**
 117    * Returns the class name of the bean.
 118    *
 119    * @return the class name.
 120    */
 121   public String getClassName()
 122   {
 123     return className;
 124   }
 125
 126   /**
 127    * Returns the name of the bean.
 128    *
 129    * @return the name of the bean.
 130    */
 131   public ObjectName getObjectName()
 132   {
 133     return name;
 134   }
 135
 136   /**
 137    * Returns a hash code for this instance.  This is calculated as
 138    * the sum of the hashcodes for the bean's name and the class name.
 139    *
 140    * @return the hash code of this instance.
 141    */
 142   public int hashCode()
 143   {
 144     return name.hashCode() + className.hashCode();
 145   }
 146
 147 }