001/* LockInfo.java - Information on a lock.
002   Copyright (C) 2006 Free Software Foundation
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.lang.management;
039
040import java.beans.ConstructorProperties;
041
042/**
043 * Provides information on a lock held by a thread.
044 * A lock can be either a built-in monitor, an
045 * <emph>ownable synchronizer</emph> (i.e. a subclass
046 * of {@link java.util.concurrent.locks.AbstractOwnableSynchronizer}),
047 * or a {@link java.util.concurrent.locks.Condition}
048 * object.
049 *
050 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
051 * @since 1.6
052 */
053public class LockInfo
054{
055
056  /**
057   * The class name of the lock object.
058   */
059  private String className;
060
061  /**
062   * The identity hash code of the lock object.
063   */
064  private int identityHashCode;
065
066  /**
067   * Constructs a new {@link LockInfo} object with the
068   * specified class name and identity hash code.
069   *
070   * @param className the name of the class of the lock object.
071   * @param identityHashCode the identity hash code of the
072   *                         lock object.
073   */
074  @ConstructorProperties({"className","identityHashCode"})
075    public LockInfo(String className, int identityHashCode)
076  {
077    this.className = className;
078    this.identityHashCode = identityHashCode;
079  }
080
081  /**
082   * Returns the class name of the lock object.
083   *
084   * @return the class name of the lock object.
085   */
086  public String getClassName()
087  {
088    return className;
089  }
090
091  /**
092   * Returns the identity hash code of the lock object.
093   *
094   * @return the identity hash code of the lock object.
095   */
096  public int getIdentityHashCode()
097  {
098    return identityHashCode;
099  }
100
101  /**
102   * Returns a textual representation of the lock,
103   * constructed by concatenating the class name,
104   * <code>'@'</code> and the identity hash code
105   * in unsigned hexadecimal form.
106   *
107   * @return a textual representation of the lock.
108   */
109  public String toString()
110  {
111    return className + '@' + Integer.toHexString(identityHashCode);
112  }
113
114}