KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*******************************************************************************
2  * Copyright (c) 2004, 2005 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 import org.eclipse.core.runtime.CoreException;
15
16 /**
17  * A breakpoint that suspends when an associated variable is
18  * read or written.
19  * <p>
20  * Clients may implement this interface. Clients are not required to
21  * implement this interface to implement watchpoints, but those that do inherit
22  * default rendering of images for watchpoints from the debug platform's
23  * default label provider and actions to toggle access and modification
24  * properties of a watchpoint.
25  * </p>
26  * @since 3.1
27  */
28 public interface IWatchpoint extends IBreakpoint {
29     /**
30      * Returns whether this watchpoint will suspend execution when its associated
31      * variable is accessed (read).
32      *
33      * @return whether this is an access watchpoint
34      * @exception CoreException if unable to access the property
35      * on this breakpoint's underlying marker
36      */
37     public boolean isAccess() throws CoreException;
38     /**
39      * Sets whether this breakpoint will suspend execution when its associated
40      * variable is accessed.
41      *
42      * @param access whether to suspend on access
43      * @exception CoreException if unable to set the property on this breakpoint's
44      * underlying marker or if the capability is not supported
45      */
46     public void setAccess(boolean access) throws CoreException;
47     /**
48      * Returns whether this watchpoint will suspend execution when its associated
49      * variable is written.
50      *
51      * @return whether this is a modification watchpoint
52      * @exception CoreException if unable to access the property
53      * on this breakpoint's underlying marker
54      */
55     public boolean isModification() throws CoreException;
56     /**
57      * Sets whether this breakpoint will suspend execution when its associated
58      * variable is modified.
59      *
60      * @param modification whether to suspend on modification
61      * @exception CoreException if unable to set the property on
62      * this breakpoint's underlying marker or if the capability is not supported
63      */
64     public void setModification(boolean modification) throws CoreException;
65     /**
66      * Returns whether this breakpoints supports the capability to suspend
67      * when an associated variable is read.
68      *
69      * @return whether this breakpoints supports the capability to suspend
70      * when an associated variable is read
71      */
72     public boolean supportsAccess();
73     /**
74      * Returns whether this breakpoints supports the ability to suspend
75      * when an associated variable is written.
76      *
77      * @return whether this breakpoints supports the ability to suspend
78      * when an associated variable is written
79      */
80     public boolean supportsModification();
81
82 }
83
84
Popular Tags