/*
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.jdi.event;
import com.sun.jdi.*;
/**
* Notification that a thread in the target VM is about to
* wait on a monitor object.
* <P>
*
* @see EventQueue
* @see MonitorWaitedEvent
*
* @author Swamy Venkataramanappa
* @since 1.6
*/
public interface MonitorWaitEvent extends LocatableEvent {
/**
* Returns the thread in which monitor wait event has occurred.
* <p>
*
* @return a {@link ThreadReference} which mirrors the event's thread in
* the target VM.
*/
public ThreadReference thread();
/**
* Returns the monitor object that the thread about to wait.
*
* @return an {@link ObjectReference} for the monitor.
*/
public ObjectReference monitor();
/**
* Returns the number of millisecond the thread will wait.
*
* @return a <code>jlong</code> containing monitor wait time in milliseconds.
*/
public long timeout();
}