01: /*
02: * Copyright 1998-2004 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * 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:
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: public interface MethodExitEvent extends LocatableEvent {
44:
45: /**
46: * Returns the method that was exited.
47: *
48: * @return a {@link Method} which mirrors the method that was exited.
49: * @throws ObjectCollectedException may be thrown if class
50: * has been garbage collected.
51: */
52: public Method method();
53:
54: /**
55: * Returns the value that the method will return.
56: *
57: * Not all target virtual machines support this operation.
58: * Use
59: * {@link VirtualMachine#canGetMethodReturnValues() canGetMethodReturnValues()}
60: * to determine if this operation is supported.
61: *
62: * @return a {@link Value} which mirrors the value to be returned.
63: *
64: * @throws java.lang.UnsupportedOperationException if
65: * the target virtual machine does not support this
66: * operation - see
67: * {@link VirtualMachine#canGetMethodReturnValues() canGetMethodReturnValues()}
68: *
69: * @since 1.6
70: */
71:
72: public Value returnValue();
73: }
|