View Javadoc
1   /*
2    * Copyright (c) 2005, 2017, 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.event;
27  
28  import com.sun.jdi.ObjectReference;
29  import com.sun.jdi.ThreadReference;
30  
31  /**
32   * Notification that a thread in the target VM has finished
33   * waiting on an monitor object.
34   *
35   * @see EventQueue
36   * @see MonitorWaitEvent
37   *
38   * @author Swamy Venkataramanappa
39   * @since  1.6
40   */
41  public interface MonitorWaitedEvent extends LocatableEvent {
42  
43      /**
44       * Returns the thread in which this event has occurred.
45       *
46       * @return a {@link ThreadReference} which mirrors the event's thread in
47       * the target VM.
48       */
49      public ThreadReference thread();
50  
51      /**
52       * Returns the monitor object this thread waited on.
53       *
54       * @return an {@link ObjectReference} for the monitor.
55       */
56      public ObjectReference monitor();
57  
58      /**
59       * Returns whether the wait has timed out or been interrupted.
60       *
61       * @return {@code true} if the wait is timed out.
62       */
63      public boolean timedout();
64  }