KickJava   Java API By Example, From Geeks To Geeks.

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


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 java.util.List JavaDoc;
23 import org.netbeans.api.gsf.annotations.NonNull;
24 import org.netbeans.api.gsf.OffsetRange;
25 import org.netbeans.api.gsf.HtmlFormatter;
26 import org.netbeans.api.gsf.StructureItem;
27
28 /**
29  * Given a parse tree, scan its structure and produce a flat list of
30  * structure items suitable for display in a navigator / outline / structure
31  * view
32  *
33  * @todo Make this a CancellableTask
34  *
35  * @author Tor Norbye
36  */
37 public interface StructureScanner {
38     /**
39      * Compute a list of structure items from the parse tree. The provided
40      * {@link HtmlFormatter} can be used to format the HTML strings required for
41      * StructureItems.
42      */
43     List JavaDoc<? extends StructureItem> scan(@NonNull CompilationInfo info, HtmlFormatter formatter);
44     
45     /**
46      * @todo Do this in the same pass as the structure scan?
47      * Compute a list of foldable regions
48      */
49     List JavaDoc<OffsetRange> folds(@NonNull CompilationInfo info);
50 }
51
Popular Tags