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
26package com.sun.jdi.event;
27
28import com.sun.jdi.*;
29
30/**
31 * Notification of a new running thread in the target VM.
32 * The new thread can be the result of a call to
33 * <code>{@link java.lang.Thread#start}</code> or the result of
34 * attaching a new thread to the VM though JNI. The
35 * notification is generated by the new thread some time before
36 * its execution starts.
37 * Because of this timing, it is possible to receive other events
38 * for the thread before this event is received. (Notably,
39 * {@link MethodEntryEvent}s and {@link MethodExitEvent}s might occur
40 * during thread initialization.)
41 * It is also possible for {@link VirtualMachine#allThreads} to return
42 * a new started thread before this event is received.
43 * <p>
44 * Note that this event gives no information
45 * about the creation of the thread object which may have happened
46 * much earlier, depending on the VM being debugged.
47 *
48 * @see EventQueue
49 * @see VirtualMachine
50 * @see ThreadReference
51 *
52 * @author Robert Field
53 * @since  1.3
54 */
55public interface ThreadStartEvent extends Event {
56    /**
57     * Returns the thread which has started.
58     *
59     * @return a {@link ThreadReference} which mirrors the event's thread in
60     * the target VM.
61     */
62    public ThreadReference thread();
63}
64