KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > gsf > ParserResult


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 NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.api.gsf;
21
22 import javax.swing.tree.TreeNode JavaDoc;
23 import org.netbeans.api.gsf.Element;
24
25
26 /**
27  * Result from a Parser. Typically subclassed by each parser implementation
28  * to stash additional information it might need, such as an AST root node,
29  * for use by related clients of the parse tree such as the code completion
30  * or declaration finders.
31  *
32  * @todo Stash the errors on the parser result too? Sounds reasonable!
33  *
34  * @author Tor Norbye
35  */
36 public abstract class ParserResult {
37     protected final ParserFile file;
38
39     /** Creates a new instance of ParserResult */
40     public ParserResult(ParserFile file) {
41         this.file = file;
42     }
43     
44     // Todo: Rename to getRootObject
45 public abstract Element getRoot();
46
47     /** AST tree - optional; for debugging only */
48     public abstract AstTreeNode getAst();
49
50     // XXX Make top level, and document debugging purpose.
51 // And remove all references to it in the client code.
52 public interface AstTreeNode extends TreeNode JavaDoc {
53         public Object JavaDoc getAstNode();
54         public int getStartOffset();
55         public int getEndOffset();
56     }
57     
58     public ParserFile getFile() {
59         return file;
60     }
61 }
62
Popular Tags