KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*******************************************************************************
2  * Copyright (c) 2000, 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 /**
14  * Support for step filters for a debug target. A debug target
15  * that supports step filters should implement this interface.
16  * Step filters can be toggled on/off for a debug target via
17  * this interface. When a step method is called (see
18  * <code>IStep</code>), the step implementation must respect
19  * the state of the step filters as defined by this interface.
20  * This allows step filters to be toggled on/off for
21  * all stepping operations (in, over, return).
22  * <p>
23  * Step filter management is debug model specific - this interface
24  * is used only to turn them on/off.
25  * </p>
26  * <p>
27  * In 2.1, the <code>IFilteredStep</code> interface was used
28  * to implement step filtering. The <code>IFilteredStep</code>
29  * interface is now deprecated, and this interface should be used
30  * in its place to allow filters to be applied to any step
31  * function.
32  * </p>
33  * <p>
34  * Clients may implement this interface. Debug targets that support
35  * step filters should implement this interface.
36  * </p>
37  * @see org.eclipse.debug.core.model.IStep
38  * @since 3.0
39  */

40 public interface IStepFilters {
41     
42     /**
43      * Returns whether this debug target supports step filters.
44      *
45      * @return whether this debug target supports step filters
46      */

47     public boolean supportsStepFilters();
48     
49     /**
50      * Returns whether step filters are currently enabled in this
51      * debug target.
52      *
53      * @return whether step filters are currently enabled in this
54      * debug target
55      */

56     public boolean isStepFiltersEnabled();
57     
58     /**
59      * Sets whether step filters are enabled in this debug target.
60      *
61      * @param enabled whether step filters are enabled in this debug target
62      */

63     public void setStepFiltersEnabled(boolean enabled);
64 }
65
Popular Tags