StackIntrospection.java revision 12657:6ef01bd40ce2 
1/*
2 * Copyright (c) 2014, 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.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23package jdk.vm.ci.code.stack;
24
25import jdk.vm.ci.meta.ResolvedJavaMethod;
26
27public interface StackIntrospection {
28
29    /**
30     * Accesses the current stack, providing {@link InspectedFrame}s to the visitor that can be used
31     * to inspect the stack frames' contents. Iteration continues as long as
32     * {@link InspectedFrameVisitor#visitFrame}, which is invoked for every {@link InspectedFrame},
33     * returns null. Any non-null result of the visitor indicates that frame iteration should stop.
34     *
35     * @param initialMethods if this is non-{@code null}, then the stack trace will start at these
36     *            methods
37     * @param matchingMethods if this is non-{@code null}, then only matching stack frames are
38     *            returned
39     * @param initialSkip the number of matching methods to skip (including the initial method)
40     * @param visitor the visitor that is called for every matching method
41     * @return the last result returned by the visitor (which is non-null to indicate that iteration
42     *         should stop), or null if the whole stack was iterated.
43     */
44    <T> T iterateFrames(ResolvedJavaMethod[] initialMethods, ResolvedJavaMethod[] matchingMethods, int initialSkip, InspectedFrameVisitor<T> visitor);
45}
46