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 
26 package com.sun.jdi.event;
27 
28 import com.sun.jdi.*;
29 
30 /**
31  * Notification of a method return in the target VM. This event
32  * is generated after all code in the method has executed, but the
33  * location of this event is the last executed location in the method.
34  * Method exit events are generated for both native and non-native
35  * methods. Method exit events are not generated if the method terminates
36  * with a thrown exception.
37  *
38  * @see EventQueue
39  *
40  * @author Robert Field
41  * @since  1.3
42  */
43 @jdk.Exported
44 public interface MethodExitEvent extends LocatableEvent {
45 
46     /**
47      * Returns the method that was exited.
48      *
49      * @return a {@link Method} which mirrors the method that was exited.
50      * @throws ObjectCollectedException may be thrown if class
51      * has been garbage collected.
52      */
method()53     public Method method();
54 
55     /**
56      * Returns the value that the method will return.
57      *
58      * Not all target virtual machines support this operation.
59      * Use
60      * {@link VirtualMachine#canGetMethodReturnValues() canGetMethodReturnValues()}
61      * to determine if this operation is supported.
62      *
63      * @return a {@link Value} which mirrors the value to be returned.
64      *
65      * @throws java.lang.UnsupportedOperationException if
66      * the target virtual machine does not support this
67      * operation - see
68      * {@link VirtualMachine#canGetMethodReturnValues() canGetMethodReturnValues()}
69      *
70      * @since 1.6
71      */
72 
returnValue()73     public Value returnValue();
74 }
75