1 /*
2  * Copyright (c) 1998, 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.event;
27 
28 import 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  */
48 @jdk.Exported
49 public interface ThreadDeathEvent extends Event {
50     /**
51      * Returns the thread which is terminating.
52      *
53      * @return a {@link ThreadReference} which mirrors the event's thread in
54      * the target VM.
55      */
thread()56     public ThreadReference thread();
57 }
58