jdk/src/jdk.jdi/share/classes/com/sun/jdi/event/MethodExitEvent.java
changeset 25859 3317bb8137f4
parent 23010 6dadb192ad81
child 34894 3248b89d1921
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/src/jdk.jdi/share/classes/com/sun/jdi/event/MethodExitEvent.java	Sun Aug 17 15:54:13 2014 +0100
@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.jdi.event;
+
+import com.sun.jdi.*;
+
+/**
+ * Notification of a method return in the target VM. This event
+ * is generated after all code in the method has executed, but the
+ * location of this event is the last executed location in the method.
+ * Method exit events are generated for both native and non-native
+ * methods. Method exit events are not generated if the method terminates
+ * with a thrown exception.
+ *
+ * @see EventQueue
+ *
+ * @author Robert Field
+ * @since  1.3
+ */
+@jdk.Exported
+public interface MethodExitEvent extends LocatableEvent {
+
+    /**
+     * Returns the method that was exited.
+     *
+     * @return a {@link Method} which mirrors the method that was exited.
+     * @throws ObjectCollectedException may be thrown if class
+     * has been garbage collected.
+     */
+    public Method method();
+
+    /**
+     * Returns the value that the method will return.
+     *
+     * Not all target virtual machines support this operation.
+     * Use
+     * {@link VirtualMachine#canGetMethodReturnValues() canGetMethodReturnValues()}
+     * to determine if this operation is supported.
+     *
+     * @return a {@link Value} which mirrors the value to be returned.
+     *
+     * @throws java.lang.UnsupportedOperationException if
+     * the target virtual machine does not support this
+     * operation - see
+     * {@link VirtualMachine#canGetMethodReturnValues() canGetMethodReturnValues()}
+     *
+     * @since 1.6
+     */
+
+    public Value returnValue();
+}