KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > debug > core > model > IDropToFrame


1 /*******************************************************************************
2  * Copyright (c) 2005, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.debug.core.model;
12
13 import org.eclipse.debug.core.DebugException;
14
15 /**
16  * Provides the ability to drop to frame. Drop to frame
17  * generally means popping a selected stack frame (and all frames above it) from
18  * the execution stack and then stepping back into the frame.
19  *
20  * @since 3.1
21  */
22 public interface IDropToFrame {
23
24     /**
25      * Returns whether this element can currently perform a drop to frame.
26      * @return whether this element can currently perform a drop to frame
27      */
28     public boolean canDropToFrame();
29     
30     /**
31      * Performs a drop to frame on this element. Implementations must generate
32      * events such that debug clients can update appropriately, such as corresponding
33      * <code>RESUME</code> and <code>SUSPEND</code> events, or a single <code>CHANGE</code>
34      * event when the drop is complete. Implementations should implement drop to frame
35      * in a non-blocking fashion.
36      *
37      * @throws DebugException on failure. Reasons include:<ul>
38      * <li>TARGET_REQUEST_FAILED - The request failed in the target</li>
39      * <li>NOT_SUPPORTED - The capability is not supported by the target</li>
40      * </ul>
41      */
42     public void dropToFrame() throws DebugException;
43 }
44
Popular Tags