/nodes/src/com/bluemarsh/jswat/nodes/stack/GetFrameCookie.java

 1/*
 2 * The contents of this file are subject to the terms of the Common Development
 3 * and Distribution License (the License). You may not use this file except in
 4 * compliance with the License.
 5 *
 6 * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
 7 * or http://www.netbeans.org/cddl.txt.
 8 *
 9 * When distributing Covered Code, include this CDDL Header Notice in each file
10 * and include the License file at http://www.netbeans.org/cddl.txt.
11 * If applicable, add the following below the CDDL Header, with the fields
12 * enclosed by brackets [] replaced by your own identifying information:
13 * "Portions Copyrighted [year] [name of copyright owner]"
14 *
15 * The Original Software is JSwat. The Initial Developer of the Original
16 * Software is Nathan L. Fiedler. Portions created by Nathan L. Fiedler
17 * are Copyright (C) 2010. All Rights Reserved.
18 *
19 * Contributor(s): Nathan L. Fiedler.
20 *
21 * $Id: GetFrameCookie.java 284 2010-11-20 22:35:20Z nathanfiedler $
22 */
23package com.bluemarsh.jswat.nodes.stack;
24
25import org.openide.nodes.Node;
26
27/**
28 * Cookie for returning the stack frame index associated with the cookie (node).
29 *
30 * @author Nathan Fiedler
31 */
32public interface GetFrameCookie extends Node.Cookie {
33
34    /**
35     * Returns the index of the frame this node represents.
36     *
37     * @return  frame index for this node (zero-based).
38     */
39    int getFrameIndex();
40}