• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
26 package 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 
35 @jdk.Exported
36 public interface MonitorInfo extends Mirror {
37 
38     /**
39      * Returns the {@link ObjectReference} object for the monitor.
40      * @return the {@link ObjectReference} object for the monitor.
41      * @throws InvalidStackFrameException if the associated stack
42      * frame has become invalid. Once the frame's thread is resumed,
43      * the stack frame is no longer valid.
44      * @see ThreadReference#ownedMonitorsAndFrames
45      * @since 1.6
46      */
monitor()47     public ObjectReference monitor();
48 
49     /**
50      * Returns the stack depth at which this monitor was
51      * acquired by the owning thread. Returns -1 if the
52      * implementation cannot determine the stack depth
53      * (e.g., for monitors acquired by JNI MonitorEnter).
54      * @return the stack depth at which this monitor was
55      * acquired by the owning thread.
56      * @throws InvalidStackFrameException if the associated stack
57      * frame has become invalid. Once the frame's thread is resumed,
58      * the stack frame is no longer valid.
59      * @see ThreadReference#ownedMonitorsAndFrames
60      */
stackDepth()61     public int stackDepth();
62 
63     /**
64      * Returns a {@link ThreadReference} object for the thread that
65      * owns the monitor.
66      * @return a {@link ThreadReference} object for the thread that
67      * owns the monitor.
68      * @throws InvalidStackFrameException if the associated stack
69      * frame has become invalid. Once the frame's thread is resumed,
70      * the stack frame is no longer valid.
71      * @see ThreadReference#frame
72      */
thread()73     ThreadReference thread();
74 }
75