KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > debug > core > IJavaLineBreakpoint


1 /*******************************************************************************
2  * Copyright (c) 2000, 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.jdt.debug.core;
12
13  
14 import org.eclipse.core.runtime.CoreException;
15 import org.eclipse.debug.core.model.ILineBreakpoint;
16
17
18 /**
19  * A breakpoint that suspends execution when a particular line of code
20  * is reached.
21  * <p>
22  * Clients are not intended to implement this interface
23  * </p>
24  * @since 2.0
25  */
26 public interface IJavaLineBreakpoint extends IJavaBreakpoint, ILineBreakpoint {
27     
28     /**
29      * Returns whether this breakpoint supports a conditional
30      * expression. Conditional breakpoints only suspend when
31      * their associated condition evaluates to <code>true</code>.
32      *
33      * @return whether this breakpoint supports a condition
34      */
35     public boolean supportsCondition();
36     /**
37      * Returns the conditional expression associated with this breakpoint,
38      * or <code>null</code> if this breakpoint does not have a condition.
39      *
40      * @return this breakpoint's conditional expression, or <code>null</code>
41      * @exception CoreException if unable to access the property on
42      * this breakpoint's underlying marker
43      */
44     public String JavaDoc getCondition() throws CoreException;
45     /**
46      * Sets the condition associated with this breakpoint.
47      * When the condition is enabled, this breakpoint will only suspend execution
48      * when the given condition evaluates to <code>true</code>.
49      * Setting the condition to <code>null</code> or an empty string removes
50      * the condition.
51      * <p>
52      * If this breakpoint does not support conditions, setting the condition has
53      * no effect.
54      * </p>
55      * @param condition conditional expression
56      * @exception CoreException if unable to set the property on
57      * this breakpoint's underlying marker
58      */
59     public void setCondition(String JavaDoc condition) throws CoreException;
60     /**
61      * Returns whether the condition on this breakpoint is enabled.
62      *
63      * @return whether this breakpoint's condition is enabled
64      * @exception CoreException if unable to access the property on
65      * this breakpoint's underlying marker
66      */
67     public boolean isConditionEnabled() throws CoreException;
68     /**
69      * Sets the enabled state of this breakpoint's condition to the given
70      * state. When enabled, this breakpoint will only suspend when its
71      * condition evaluates to true. When disabled, this breakpoint will suspend
72      * as it would with no condition defined.
73      *
74      * @exception CoreException if unable to set the property on
75      * this breakpoint's underlying marker
76      */
77     public void setConditionEnabled(boolean enabled) throws CoreException;
78     /**
79      * Returns whether the breakpoint suspends when the value of the condition
80      * is <code>true</code> or when the value of the condition changes.
81      *
82      * @return <code>true</code> if this breakpoint suspends when the value of
83      * the condition is <code>true</code>, <code>false</code> if this breakpoint
84      * suspends when the value of the condition changes.
85      * @exception CoreException if unable to access the property on
86      * this breakpoint's underlying marker
87      * @since 2.1
88      */
89     public boolean isConditionSuspendOnTrue() throws CoreException;
90     /**
91      * Set the suspend state of this breakpoint's condition. If the value is
92      * <code>true</code>, the breakpoint will stop when the value of the
93      * condition is <code>true</code>. If the value is <code>false</code>, the
94      * breakpoint will stop when the value of the condition changes.
95      *
96      * @exception CoreException if unable to access the property on this
97      * breakpoint's underlying marker
98      * @since 2.1
99      */
100     public void setConditionSuspendOnTrue(boolean suspendOnTrue) throws CoreException;
101
102 }
103
104
Popular Tags