KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*******************************************************************************
2  * Copyright (c) 2003, 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
16 /**
17  * A line breakpoint identified by its source file name and/or path, and
18  * stratum that it is relative to.
19  * <p>
20  * This interface is not intended to be implemented by clients.
21  * </p>
22  * @since 3.0
23  */
24 public interface IJavaStratumLineBreakpoint extends IJavaLineBreakpoint {
25
26     /**
27      * Returns the type name pattern this breakpoint uses to identify types
28      * in which to install itself. Patterns may begin or end with '*'. Will
29      * not return <code>null</code>. In the case that a stratum breakpoint
30      * was created with a <code>null</code> pattern, "*" is returned.
31      * <p>
32      * Multiple patterns can be specified in this breakpoint by delimiting
33      * the patterns with a comma - e.g. "x.y.z,a.b.c".
34      * </p>
35      * @return the type name patterns this breakpoint uses to identify types
36      * in which to install itself.
37      * @exception CoreException if unable to access the property from
38      * this breakpoint's underlying marker
39      */
40     public String JavaDoc getPattern() throws CoreException;
41     
42     /**
43      * Returns the simple name of the source file in which this breakpoint
44      * is set, or <code>null</code>. When this breakpoint specifies a
45      * source file name, this breakpoint is only installed in types whose
46      * source file name debug attribute matches this value, relative
47      * to this breakpoint's stratum.
48      *
49      * @return the source file name in which this breakpoint is set, or
50      * <code>null</code>
51      * @exception CoreException if unable to access the property from
52      * this breakpoint's underlying marker
53      */
54     public String JavaDoc getSourceName() throws CoreException;
55     
56     /**
57      * Returns the stratum that this breakpoint's source name, source path,
58      * and line number are relative to, or <code>null</code> if this breakpoint
59      * is relative to a type's default stratum.
60      *
61      * @return the stratum that this breakpoint's source name, source path,
62      * and line number are relative to, or <code>null</code>
63      * @throws CoreException if unable to access the property from this
64      * breakpoint's underlying marker
65      */
66     public String JavaDoc getStratum() throws CoreException;
67     
68     /**
69      * Returns the qualified source file path in which this breakpoint is set,
70      * or <code>null</code>. When specified, this breakpoint is
71      * only installed in types whose source file path debug attribute
72      * matches this value, relative to this breakpoint's stratum.
73      *
74      * @return the qualified source file path in which this breakpoint is set,
75      * or <code>null</code>
76      * @throws CoreException
77      */
78     public String JavaDoc getSourcePath() throws CoreException;
79
80 }
81
82
Popular Tags