KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > retouche > hints > spi > Rule


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.retouche.hints.spi;
21
22 /** Represents a rule to be run on the java source.
23  * Only contains the basic identification and UI properties of the rule.
24  * Instances of the rules can be placed into the system filesystem.
25  *
26  * @author Petr Hrebejk
27  */
28 public interface Rule {
29     
30     /** Gets unique ID of the rule
31      */
32     public String JavaDoc getId();
33
34     /** Get's UI usable name of the rule
35      */
36     public String JavaDoc getDisplayName();
37
38     /** Gets longer description of the rule
39      */
40     public String JavaDoc getDescription();
41
42     // XXX Add Others
43 // public JPanel getCustomizer() or Hash map getParameters()
44
45 }
46
Popular Tags