IJavaMethodBreakpoint


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.jdt.debug.core;
12  
13   
14  import org.eclipse.core.runtime.CoreException;
15  import org.eclipse.debug.core.model.IDebugTarget;
16  
17  /**
18   * A method breakpoint suspends execution when a
19   * method is entered or exited.
20   * <p>
21   * Clients are not intended to implement this interface.
22   * </p>
23   * @since 2.0
24   */
25  public interface IJavaMethodBreakpoint extends IJavaLineBreakpoint {
26  
27      /**
28       * Returns the name of the method(s) this breakpoint suspends
29       * execution in, or <code>null</code> if this breakpoint does
30       * not suspend execution based on method name.
31       * 
32       * @return the name of the method(s) this breakpoint suspends
33       * execution in, or <code>null</code> if this breakpoint does
34       * not suspend execution based on method name
35       * @exception CoreException if unable to access the property from
36       *  this breakpoint's underlying marker
37       */
38      public String   getMethodName() throws CoreException;
39      
40      /**
41       * Returns the signature of the method(s) this breakpoint suspends
42       * execution in, or <code>null</code> if this breakpoint does not
43       * suspend execution based on method signature.
44       * 
45       * @return the signature of the method(s) this breakpoint suspends
46       * execution in, or <code>null</code> if this breakpoint does not
47       * suspend execution based on method signature
48       * @exception CoreException if unable to access the property from
49       *  this breakpoint's underlying marker
50       */
51      public String   getMethodSignature() throws CoreException;    
52      
53      /**
54       * Returns the pattern specifying the fully qualified name of type(s)
55       * this breakpoint suspends execution in. Patterns are limited to exact
56       * matches and patterns that begin or end with '*'.
57       * 
58       * @return the pattern specifying the fully qualified name of type(s)
59       * this breakpoint suspends execution in
60       * @exception CoreException if unable to access the property from
61       *  this breakpoint's underlying marker
62       * @see IJavaBreakpoint#getTypeName()
63       */
64      public String   getTypeName() throws CoreException;   
65      
66      /**
67       * Returns whether this breakpoint causes execution to suspend
68       * on entry to methods.
69       * 
70       * @return whether this breakpoint causes execution to suspend
71       * on entry to methods
72       * @exception CoreException if unable to access the property from
73       *  this breakpoint's underlying marker
74       */
75      public boolean isEntry() throws CoreException;
76      
77      /**
78       * Returns whether this breakpoint causes execution to suspend
79       * on exit of methods.
80       * 
81       * @return whether this breakpoint causes execution to suspend
82       * on exit of methods
83       * @exception CoreException if unable to access the property from
84       *  this breakpoint's underlying marker
85       */
86      public boolean isExit() throws CoreException;   
87      
88      /**
89       * Sets whether this breakpoint causes execution to suspend
90       * on entry to methods.
91       * 
92       * @param entry whether this breakpoint causes execution to suspend
93       * on entry to methods
94       * @exception CoreException if unable to set the property on
95       *  this breakpoint's underlying marker
96       */
97      public void setEntry(boolean entry) throws CoreException;   
98      
99      /**
100      * Sets whether this breakpoint causes execution to suspend
101      * on exit of methods.
102      * 
103      * @param exit whether this breakpoint causes execution to suspend
104      * on exit of methods
105      * @exception CoreException if unable to set the property on
106      *  this breakpoint's underlying marker
107      */
108     public void setExit(boolean exit) throws CoreException; 
109     
110     /**
111      * Sets whether this breakpoint causes execution to suspend
112      * only on entry/exit of native methods.
113      * 
114      * @param nativeOnly whether this breakpoint causes execution to suspend
115      * only on entry/exit of native methods
116      * @exception CoreException if unable to set the property on
117      *  this breakpoint's underlying marker
118      */
119     public void setNativeOnly(boolean nativeOnly) throws CoreException; 
120     
121     /**
122      * Returns whether this breakpoint causes execution to suspend
123      * only on entry/exit of native methods.
124      * 
125      * @return whether this breakpoint causes execution to suspend
126      * only on entry/exit of native methods
127      * @exception CoreException if unable to access the property
128      *  on this breakpoint's underlying marker
129      */
130     public boolean isNativeOnly() throws CoreException; 
131     
132     /**
133      * Returns whether this breakpoint last suspended in the given
134      * target due to a method entry (<code>true</code>) or exit
135      * (<code>false</code>).
136      * 
137      * @return <code>true</code> if this breakpoint last suspended the given
138      *  target due to a method entry; <code>false</code> if this breakpoint last
139      *  suspended in the given target due to a method exit or if this
140      *  breakpoint hasn't suspended the given target.
141      */
142     public boolean isEntrySuspend(IDebugTarget target); 
143 }
144 
145
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags