src/java.management/share/classes/javax/management/ObjectInstance.java
author darcy
Wed, 23 Oct 2019 13:01:40 -0700
changeset 58766 54ffb15c4839
parent 47216 71c04702a3d5
permissions -rw-r--r--
8232442: Suppress warnings on non-serializable non-transient instance fields in java.management.* Reviewed-by: rriggs, mchung
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1999, 2004, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.management;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
// java import
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.io.Serializable;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
// RI import
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
import javax.management.ObjectName;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * Used to represent the object name of an MBean and its class name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * If the MBean is a Dynamic MBean the class name should be retrieved from
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * the <CODE>MBeanInfo</CODE> it provides.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
public class ObjectInstance implements Serializable   {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
    /* Serial version */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
    private static final long serialVersionUID = -4099952623687795850L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * @serial Object name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    private ObjectName name;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     * @serial Class name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    private String className;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * Allows an object instance to be created given a string representation of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * an object name and the full class name, including the package name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * @param objectName  A string representation of the object name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * @param className The full class name, including the package
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * name, of the object instance.  If the MBean is a Dynamic MBean
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * the class name corresponds to its {@link
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * DynamicMBean#getMBeanInfo()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * getMBeanInfo()}<code>.getClassName()</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * @exception MalformedObjectNameException The string passed as a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * parameter does not have the right format.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
    public ObjectInstance(String objectName, String className)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
            throws MalformedObjectNameException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
        this(new ObjectName(objectName), className);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     * Allows an object instance to be created given an object name and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     * the full class name, including the package name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * @param objectName  The object name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * @param className  The full class name, including the package
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * name, of the object instance.  If the MBean is a Dynamic MBean
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * the class name corresponds to its {@link
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * DynamicMBean#getMBeanInfo()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * getMBeanInfo()}<code>.getClassName()</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     * If the MBean is a Dynamic MBean the class name should be retrieved
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     * from the <CODE>MBeanInfo</CODE> it provides.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
    public ObjectInstance(ObjectName objectName, String className) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
        if (objectName.isPattern()) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
            final IllegalArgumentException iae =
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
                new IllegalArgumentException("Invalid name->"+
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
                                             objectName.toString());
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
            throw new RuntimeOperationsException(iae);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
        this.name= objectName;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
        this.className= className;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     * Compares the current object instance with another object instance.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
     * @param object  The object instance that the current object instance is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     *     to be compared with.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
     * @return  True if the two object instances are equal, otherwise false.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
    public boolean equals(Object object)  {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
        if (!(object instanceof ObjectInstance)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
            return false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
        ObjectInstance val = (ObjectInstance) object;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
        if (! name.equals(val.getObjectName())) return false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
        if (className == null)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
            return (val.getClassName() == null);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
        return className.equals(val.getClassName());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
    public int hashCode() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
        final int classHash = ((className==null)?0:className.hashCode());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
        return name.hashCode() ^ classHash;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
     * Returns the object name part.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
     * @return the object name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
    public ObjectName getObjectName()  {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
        return name;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
     * Returns the class part.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
     * @return the class name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
    public String getClassName()  {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
        return className;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
     * Returns a string representing this ObjectInstance object. The format of this string
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
     * is not specified, but users can expect that two ObjectInstances return the same
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
     * string if and only if they are equal.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
    public String toString() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
        return getClassName() + "[" + getObjectName() + "]";
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
 }