01: /*******************************************************************************
02: * Copyright (c) 2003, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.jdt.debug.core;
11:
12: import org.eclipse.core.runtime.CoreException;
13:
14: /**
15: * A line breakpoint identified by its source file name and/or path, and
16: * stratum that it is relative to.
17: * <p>
18: * This interface is not intended to be implemented by clients.
19: * </p>
20: * @since 3.0
21: */
22: public interface IJavaStratumLineBreakpoint extends IJavaLineBreakpoint {
23:
24: /**
25: * Returns the type name pattern this breakpoint uses to identify types
26: * in which to install itself. Patterns may begin or end with '*'. Will
27: * not return <code>null</code>. In the case that a stratum breakpoint
28: * was created with a <code>null</code> pattern, "*" is returned.
29: * <p>
30: * Multiple patterns can be specified in this breakpoint by delimiting
31: * the patterns with a comma - e.g. "x.y.z,a.b.c".
32: * </p>
33: * @return the type name patterns this breakpoint uses to identify types
34: * in which to install itself.
35: * @exception CoreException if unable to access the property from
36: * this breakpoint's underlying marker
37: */
38: public String getPattern() throws CoreException;
39:
40: /**
41: * Returns the simple name of the source file in which this breakpoint
42: * is set, or <code>null</code>. When this breakpoint specifies a
43: * source file name, this breakpoint is only installed in types whose
44: * source file name debug attribute matches this value, relative
45: * to this breakpoint's stratum.
46: *
47: * @return the source file name in which this breakpoint is set, or
48: * <code>null</code>
49: * @exception CoreException if unable to access the property from
50: * this breakpoint's underlying marker
51: */
52: public String getSourceName() throws CoreException;
53:
54: /**
55: * Returns the stratum that this breakpoint's source name, source path,
56: * and line number are relative to, or <code>null</code> if this breakpoint
57: * is relative to a type's default stratum.
58: *
59: * @return the stratum that this breakpoint's source name, source path,
60: * and line number are relative to, or <code>null</code>
61: * @throws CoreException if unable to access the property from this
62: * breakpoint's underlying marker
63: */
64: public String getStratum() throws CoreException;
65:
66: /**
67: * Returns the qualified source file path in which this breakpoint is set,
68: * or <code>null</code>. When specified, this breakpoint is
69: * only installed in types whose source file path debug attribute
70: * matches this value, relative to this breakpoint's stratum.
71: *
72: * @return the qualified source file path in which this breakpoint is set,
73: * or <code>null</code>
74: * @throws CoreException
75: */
76: public String getSourcePath() throws CoreException;
77:
78: }
|