1 /*
2 * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
24 */
25
26 package com.sun.jdi;
27
28 import java.util.List;
29
30 /**
31 * A point within the executing code of the target VM.
32 * Locations are used to identify the current position of
33 * a suspended thread (analogous to an instruction pointer or
34 * program counter register in native programs). They are also used
35 * to identify the position at which to set a breakpoint.
36 * <p>
37 * The availability of a line number for a location will
38 * depend on the level of debugging information available from the
39 * target VM.
40 * <p>
41 * Several mirror interfaces have locations. Each such mirror
42 * extends a {@link Locatable} interface.
43 * <p>
44 * <a name="strata"><b>Strata</b></a>
45 * <p>
46 * The source information for a Location is dependent on the
47 * <i>stratum</i> which is used. A stratum is a source code
48 * level within a sequence of translations. For example,
49 * say the baz program is written in the programming language
50 * "Foo" then translated to the language "Bar" and finally
51 * translated into the Java programming language. The
52 * Java programming language stratum is named
53 * <code>"Java"</code>, let's say the other strata are named
54 * "Foo" and "Bar". A given location (as viewed by the
55 * {@link #sourceName()} and {@link #lineNumber()} methods)
56 * might be at line 14 of "baz.foo" in the <code>"Foo"</code>
57 * stratum, line 23 of "baz.bar" in the <code>"Bar"</code>
58 * stratum and line 71 of the <code>"Java"</code> stratum.
59 * Note that while the Java programming language may have
60 * only one source file for a reference type, this restriction
61 * does not apply to other strata - thus each Location should
62 * be consulted to determine its source path.
63 * Queries which do not specify a stratum
64 * ({@link #sourceName()}, {@link #sourcePath()} and
|
1 /*
2 * Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
24 */
25
26 package com.sun.jdi;
27
28 import java.util.List;
29
30 /**
31 * A point within the executing code of the target VM.
32 * Locations are used to identify the current position of
33 * a suspended thread (analogous to an instruction pointer or
34 * program counter register in native programs). They are also used
35 * to identify the position at which to set a breakpoint.
36 * <p>
37 * The availability of a line number for a location will
38 * depend on the level of debugging information available from the
39 * target VM.
40 * <p>
41 * Several mirror interfaces have locations. Each such mirror
42 * extends a {@link Locatable} interface.
43 * <p>
44 * <a id="strata"><b>Strata</b></a>
45 * <p>
46 * The source information for a Location is dependent on the
47 * <i>stratum</i> which is used. A stratum is a source code
48 * level within a sequence of translations. For example,
49 * say the baz program is written in the programming language
50 * "Foo" then translated to the language "Bar" and finally
51 * translated into the Java programming language. The
52 * Java programming language stratum is named
53 * <code>"Java"</code>, let's say the other strata are named
54 * "Foo" and "Bar". A given location (as viewed by the
55 * {@link #sourceName()} and {@link #lineNumber()} methods)
56 * might be at line 14 of "baz.foo" in the <code>"Foo"</code>
57 * stratum, line 23 of "baz.bar" in the <code>"Bar"</code>
58 * stratum and line 71 of the <code>"Java"</code> stratum.
59 * Note that while the Java programming language may have
60 * only one source file for a reference type, this restriction
61 * does not apply to other strata - thus each Location should
62 * be consulted to determine its source path.
63 * Queries which do not specify a stratum
64 * ({@link #sourceName()}, {@link #sourcePath()} and
|