1/*
2 * Copyright (c) 1998, 2017, 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.Mirror;
29import com.sun.jdi.VirtualMachine;
30import com.sun.jdi.request.EventRequest;
31
32/**
33 * An occurrence in a target VM that is of interest to a debugger. Event is
34 * the common superinterface for all events (examples include
35 * {@link BreakpointEvent}, {@link ExceptionEvent},
36 * {@link ClassPrepareEvent}).
37 * When an event occurs, an instance of Event as a component of
38 * an {@link EventSet} is enqueued in the
39 * {@link VirtualMachine}'s {@link EventQueue}.
40 *
41 * @see EventSet
42 * @see EventQueue
43 *
44 * @author Robert Field
45 * @since  1.3
46 */
47public interface Event extends Mirror {
48
49    /**
50     * @return The {@link EventRequest} that requested this event.
51     * Some events (eg. {@link VMDeathEvent}) may not have
52     * a cooresponding request and thus will return null.
53     */
54    EventRequest request();
55}
56