KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > percederberg > grammatica > code > csharp > CSharpUsing


1 /*
2  * CSharpUsing.java
3  *
4  * This work is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published
6  * by the Free Software Foundation; either version 2 of the License,
7  * or (at your option) any later version.
8  *
9  * This work is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
17  * USA
18  *
19  * As a special exception, the copyright holders of this library give
20  * you permission to link this library with independent modules to
21  * produce an executable, regardless of the license terms of these
22  * independent modules, and to copy and distribute the resulting
23  * executable under terms of your choice, provided that you also meet,
24  * for each linked independent module, the terms and conditions of the
25  * license of that module. An independent module is a module which is
26  * not derived from or based on this library. If you modify this
27  * library, you may extend this exception to your version of the
28  * library, but you are not obligated to do so. If you do not wish to
29  * do so, delete this exception statement from your version.
30  *
31  * Copyright (c) 2003 Per Cederberg. All rights reserved.
32  */
33
34 package net.percederberg.grammatica.code.csharp;
35
36 import java.io.PrintWriter JavaDoc;
37 import net.percederberg.grammatica.code.CodeElement;
38 import net.percederberg.grammatica.code.CodeStyle;
39
40 /**
41  * A class generating a C# using declaration.
42  *
43  * @author Per Cederberg, <per at percederberg dot net>
44  * @version 1.0
45  */
46 public class CSharpUsing extends CodeElement {
47
48     /**
49      * The namespace being used.
50      */
51     private String JavaDoc namespace;
52
53     /**
54      * Creates a new C# using declaration.
55      *
56      * @param namespace the namespace being used
57      */
58     public CSharpUsing(String JavaDoc namespace) {
59         this.namespace = namespace;
60     }
61
62     /**
63      * Compares this object to another one. The comparison is based
64      * primarily on the code element category, and secondarily on the
65      * namespace.
66      *
67      * @param obj the object to compare to
68      *
69      * @return negative if this object preceeds the other one,
70      * zero (0) if the objects are equal, or
71      * positive if this object succeeds the other one
72      */
73     public int compareTo(Object JavaDoc obj) {
74         int value = super.compareTo(obj);
75
76         if (value == 0) {
77             return namespace.compareTo(obj.toString());
78         } else {
79             return value;
80         }
81     }
82
83     /**
84      * Returns true if this object is equal to another.
85      *
86      * @param obj the object to compare to
87      *
88      * @return true if the objects are equal, or
89      * false otherwise
90      */
91     public boolean equals(Object JavaDoc obj) {
92         return compareTo(obj) == 0;
93     }
94
95     /**
96      * Returns the namespace to use.
97      *
98      * @return the namespace to use
99      */
100     public String JavaDoc toString() {
101         return namespace;
102     }
103
104     /**
105      * Returns a numeric category number for the code element. A lower
106      * category number implies that the code element should be placed
107      * before code elements with a higher category number within a
108      * declaration.
109      *
110      * @return the category number
111      */
112     public int category() {
113         return namespace.startsWith("System") ? 1 : 2;
114     }
115
116     /**
117      * Prints the code element to the specified output stream.
118      *
119      * @param out the output stream
120      * @param style the code style to use
121      * @param indent the indentation level
122      */
123     public void print(PrintWriter JavaDoc out, CodeStyle style, int indent) {
124         out.println(style.getIndent(indent) + "using " + namespace + ";");
125     }
126 }
127
Popular Tags