KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > java > hints > spi > TreeRule


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.modules.java.hints.spi;
21
22 import com.sun.source.tree.Tree;
23 import com.sun.source.util.TreePath;
24 import java.util.List JavaDoc;
25 import java.util.Set JavaDoc;
26 import org.netbeans.api.java.source.CompilationInfo;
27 import org.netbeans.spi.editor.hints.ErrorDescription;
28
29 /** Represents a rule to be run on the java source.
30  *
31  * @author Petr Hrebejk
32  */
33 public interface TreeRule extends Rule {
34
35     /** Get the treekinds this rule should run on
36      */
37     public Set JavaDoc<Tree.Kind> getTreeKinds();
38
39     /** Run the test on given CompilationUnit and return list of Errors or
40      * warrnings to be shown in the editor.
41      */
42     public List JavaDoc<ErrorDescription> run( CompilationInfo compilationInfo, TreePath treePath );
43
44     
45     
46 }
47
Popular Tags