jdk/src/jdk.jdi/share/classes/com/sun/jdi/request/VMDeathRequest.java
author clanger
Fri, 16 Jun 2017 14:09:31 +0200
changeset 45564 0149773a140c
parent 34894 3248b89d1921
permissions -rw-r--r--
8181417: Code cleanups in com.sun.jdi Reviewed-by: alanb, stuefe, sspitsyn
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
     2
 * Copyright (c) 2001, 2017, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package com.sun.jdi.request;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    28
import com.sun.jdi.event.EventQueue;
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    29
import com.sun.jdi.event.EventSet;
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    30
import com.sun.jdi.event.VMDeathEvent;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * Request for notification when the target VM terminates.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * When an enabled VMDeathRequest is satisfied, an
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    35
 * {@link EventSet event set} containing a
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    36
 * {@link VMDeathEvent VMDeathEvent}
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    37
 * will be placed on the {@link EventQueue EventQueue}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * The collection of existing VMDeathRequests is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * managed by the {@link EventRequestManager}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * Even without creating a VMDeathRequest, a single
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * unsolicited VMDeathEvent will be sent with a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * {@link EventRequest#suspendPolicy() suspend policy}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * of {@link EventRequest#SUSPEND_NONE SUSPEND_NONE}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * This request would typically be created so that a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * VMDeathEvent with a suspend policy of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * {@link EventRequest#SUSPEND_ALL SUSPEND_ALL}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * will be sent.  This event can be used to assure
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * completion of any processing which requires the VM
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * to be alive (e.g. event processing).  Note: the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * unsolicited VMDeathEvent will still be sent.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 *
45564
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    53
 * @see VMDeathEvent
0149773a140c 8181417: Code cleanups in com.sun.jdi
clanger
parents: 34894
diff changeset
    54
 * @see EventQueue
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * @see EventRequestManager
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 * @author Robert Field
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 * @since  1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
public interface VMDeathRequest extends EventRequest {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
}