KickJava   Java API By Example, From Geeks To Geeks.

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


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.util.TreePath;
23 import java.util.List JavaDoc;
24 import java.util.Set JavaDoc;
25 import org.netbeans.api.java.source.CompilationInfo;
26 import org.netbeans.spi.editor.hints.Fix;
27
28 /**
29  * Represents a rule to be run on the java source in case the compiler
30  * issued an error or a warning.
31  *
32  * @author Petr Hrebejk, Jan Lahoda
33  */
34 public interface ErrorRule<T> extends Rule {//XXX: should ErrorRule extend Rule?
35
36     /** Get the diagnostic codes this rule should run on
37      */
38     public Set JavaDoc<String JavaDoc> getCodes();
39
40     /** Return possible fixes for a given diagnostic report.
41      */
42     public List JavaDoc<Fix> run(CompilationInfo compilationInfo, String JavaDoc diagnosticKey, int offset, TreePath treePath, Data<T> data);
43
44     public void cancel();
45     
46     public static final class Data<T> {
47         private T o;
48         public synchronized T getData() {
49             return o;
50         }
51         
52         public synchronized void setData(T o) {
53             this.o = o;
54         }
55     }
56 }
57
Popular Tags