blob: fefc51adbbfbd999cf28bf85456122cfba13e27a [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 1998-2001 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 target VM termination.
32 * This event occurs if the target VM terminates before the
33 * VM disconnects ({@link VMDisconnectEvent}).
34 * Thus, this event will NOT occur if
35 * external forces terminate the connection (e.g. a crash)
36 * or if the connection is intentionally terminated with
37 * {@link com.sun.jdi.VirtualMachine#dispose()
38 * VirtualMachine.dispose()}
39 * <P>
40 * On VM termination, a single unsolicited VMDeathEvent
41 * will always be sent with a
42 * {@link com.sun.jdi.request.EventRequest#suspendPolicy() suspend policy}
43 * of {@link com.sun.jdi.request.EventRequest#SUSPEND_NONE SUSPEND_NONE}.
44 * Additional VMDeathEvents will be sent in the same event set if they are
45 * requested with a
46 * {@link com.sun.jdi.request.VMDeathRequest VMDeathRequest}.
47 * <P>
48 * The VM is still intact and can be queried at the point this
49 * event was initiated but immediately thereafter it is not
50 * considered intact and cannot be queried.
51 * Note: If the enclosing {@link EventSet} has a
52 * {@link com.sun.jdi.request.EventRequest#suspendPolicy() suspend policy}
53 * other than
54 * {@link com.sun.jdi.request.EventRequest#SUSPEND_ALL SUSPEND_ALL}
55 * the initiating point may be long past.
56 * <P>
57 * All VMDeathEvents will be in a single {@link EventSet},
58 * no other events will be in the event set. A resume
59 * must occur to continue execution after any event set which
60 * performs suspensions - in this case to allow proper shutdown.
61 *
62 * @see VMDisconnectEvent
63 * @see com.sun.jdi.request.EventRequestManager#createVMDeathRequest
64 * @see com.sun.jdi.request.VMDeathRequest
65 * @see EventQueue
66 * @see VirtualMachine
67 *
68 * @author Robert Field
69 * @since 1.3
70 */
71public interface VMDeathEvent extends Event {
72}