blob: 723d359b3950fcc0bacd688c008c7c3e01381642 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 1998-1999 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26package com.sun.jdi.event;
27
28import com.sun.jdi.*;
29
30/**
31 * Notification of a completed thread in the target VM. The
32 * notification is generated by the dying thread before it terminates.
33 * Because of this timing, it is possible
34 * for {@link VirtualMachine#allThreads} to return this thread
35 * after this event is received.
36 * <p>
37 * Note that this event gives no information
38 * about the lifetime of the thread object. It may or may not be collected
39 * soon depending on what references exist in the target VM.
40 *
41 * @see EventQueue
42 * @see VirtualMachine
43 * @see ThreadReference
44 *
45 * @author Robert Field
46 * @since 1.3
47 */
48public interface ThreadDeathEvent extends Event {
49 /**
50 * Returns the thread which is terminating.
51 *
52 * @return a {@link ThreadReference} which mirrors the event's thread in
53 * the target VM.
54 */
55 public ThreadReference thread();
56}