ExceptionEvent.java revision 2362
0N/A/*
1472N/A * Copyright (c) 1998, 1999, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
1472N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1472N/A *
1472N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0N/A * or visit www.oracle.com if you need additional information or have any
0N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.jdi.event;
0N/A
0N/Aimport com.sun.jdi.*;
0N/A
0N/A/**
0N/A * Notification of an exception in the target VM. When an exception
0N/A * is thrown which satisfies a currently enabled
0N/A * {@link com.sun.jdi.request.ExceptionRequest exception request},
0N/A * an {@link EventSet event set}
1387N/A * containing an instance of this class will be added
0N/A * to the VM's event queue.
0N/A * If the exception is thrown from a non-native method,
0N/A * the exception event is generated at the location where the
0N/A * exception is thrown.
0N/A * If the exception is thrown from a native method, the exception event
0N/A * is generated at the first non-native location reached after the exception
0N/A * is thrown.
0N/A *
0N/A * @author Robert Field
0N/A * @since 1.3
0N/A */
0N/Apublic interface ExceptionEvent extends LocatableEvent {
0N/A
0N/A /**
0N/A * Gets the thrown exception object. The exception object is
0N/A * an instance of {@link java.lang.Throwable} or a subclass in the
0N/A * target VM.
0N/A *
0N/A * @return an {@link ObjectReference} which mirrors the thrown object in
0N/A * the target VM.
0N/A */
0N/A public ObjectReference exception();
/**
* Gets the location where the exception will be caught. An exception
* is considered to be caught if, at the point of the throw, the
* current location is dynamically enclosed in a try statement that
* handles the exception. (See the JVM specification for details).
* If there is such a try statement, the catch location is the
* first code index of the appropriate catch clause.
* <p>
* If there are native methods in the call stack at the time of the
* exception, there are important restrictions to note about the
* returned catch location. In such cases,
* it is not possible to predict whether an exception will be handled
* by some native method on the call stack.
* Thus, it is possible that exceptions considered uncaught
* here will, in fact, be handled by a native method and not cause
* termination of the target VM. Furthermore, it cannot be assumed that the
* catch location returned here will ever be reached by the throwing
* thread. If there is
* a native frame between the current location and the catch location,
* the exception might be handled and cleared in that native method
* instead.
* <p>
* Note that the compiler can generate try-catch blocks in some cases
* where they are not explicit in the source code; for example,
* the code generated for <code>synchronized</code> and
* <code>finally</code> blocks can contain implicit try-catch blocks.
* If such an implicitly generated try-catch is
* present on the call stack at the time of the throw, the exception
* will be considered caught even though it appears to be uncaught from
* examination of the source code.
*
* @return the {@link Location} where the exception will be caught or null if
* the exception is uncaught.
*/
public Location catchLocation();
}