/*
* Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.max.vm.stack;
import com.sun.max.annotate.*;
/**
* A visitor for traversing the frames on a thread's stack. The details of each frame traversed in the
* stack walk are passed to {@link #visitFrame(StackFrame)}
* in a newly allocated {@link StackFrame} object.
*
* @see RawStackFrameVisitor
*/
@HOSTED_ONLY
public abstract class StackFrameVisitor {
/**
* Processes a given frame that is being traversed as part of a {@linkplain StackFrameWalker#walk stack walk}.
*
* @param stackFrame an object encapsulating the details of the frame
* @return true if the walk should continue to the caller of {@code stackFrame}, false if it should terminate now
*/
public abstract boolean visitFrame(StackFrame stackFrame);
/**
* Notifies this visitor that a stack walk is done.
*/
public void done() {
}
}