blob: 5fe43a2e97779bfe3a27d1d2cdf4904ded38f2b8 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 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.request;
27
28import com.sun.jdi.*;
29
30/**
31 * Request for notification when the target VM terminates.
32 * When an enabled VMDeathRequest is satisfied, an
33 * {@link com.sun.jdi.event.EventSet event set} containing a
34 * {@link com.sun.jdi.event.VMDeathEvent VMDeathEvent}
35 * will be placed on the
36 * {@link com.sun.jdi.event.EventQueue EventQueue}.
37 * The collection of existing VMDeathRequests is
38 * managed by the {@link EventRequestManager}
39 * <P>
40 * Even without creating a VMDeathRequest, a single
41 * unsolicited VMDeathEvent will be sent with a
42 * {@link EventRequest#suspendPolicy() suspend policy}
43 * of {@link EventRequest#SUSPEND_NONE SUSPEND_NONE}.
44 * This request would typically be created so that a
45 * VMDeathEvent with a suspend policy of
46 * {@link EventRequest#SUSPEND_ALL SUSPEND_ALL}
47 * will be sent. This event can be used to assure
48 * completion of any processing which requires the VM
49 * to be alive (e.g. event processing). Note: the
50 * unsolicited VMDeathEvent will still be sent.
51 *
52 * @see com.sun.jdi.event.VMDeathEvent
53 * @see com.sun.jdi.event.EventQueue
54 * @see EventRequestManager
55 *
56 * @author Robert Field
57 * @since 1.4
58 */
59public interface VMDeathRequest extends EventRequest {
60
61}