1/*
2 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.jdi;
27
28/**
29 * Information about a monitor owned by a thread.
30 *
31 * @author Swamy Venkataramanappa
32 * @since  1.6
33 */
34
35public interface MonitorInfo extends Mirror {
36
37    /**
38     * Returns the {@link ObjectReference} object for the monitor.
39     * @return the {@link ObjectReference} object for the monitor.
40     * @throws InvalidStackFrameException if the associated stack
41     * frame has become invalid. Once the frame's thread is resumed,
42     * the stack frame is no longer valid.
43     * @see ThreadReference#ownedMonitorsAndFrames
44     * @since 1.6
45     */
46    public ObjectReference monitor();
47
48    /**
49     * Returns the stack depth at which this monitor was
50     * acquired by the owning thread. Returns -1 if the
51     * implementation cannot determine the stack depth
52     * (e.g., for monitors acquired by JNI MonitorEnter).
53     * @return the stack depth at which this monitor was
54     * acquired by the owning thread.
55     * @throws InvalidStackFrameException if the associated stack
56     * frame has become invalid. Once the frame's thread is resumed,
57     * the stack frame is no longer valid.
58     * @see ThreadReference#ownedMonitorsAndFrames
59     */
60    public int stackDepth();
61
62    /**
63     * Returns a {@link ThreadReference} object for the thread that
64     * owns the monitor.
65     * @return a {@link ThreadReference} object for the thread that
66     * owns the monitor.
67     * @throws InvalidStackFrameException if the associated stack
68     * frame has become invalid. Once the frame's thread is resumed,
69     * the stack frame is no longer valid.
70     * @see ThreadReference#frame
71     */
72    ThreadReference thread();
73}
74