KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > percederberg > grammatica > code > visualbasic > VisualBasicNamespace


1 /*
2  * VisualBasicNamespace.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) 2004 Adrian Moore. All rights reserved.
32  * Copyright (c) 2004 Per Cederberg. All rights reserved.
33  */
34
35 package net.percederberg.grammatica.code.visualbasic;
36
37 import java.io.PrintWriter JavaDoc;
38 import net.percederberg.grammatica.code.CodeElementContainer;
39 import net.percederberg.grammatica.code.CodeStyle;
40
41 /**
42  * A class generating a Visual Basic namespace declaration.
43  *
44  * @author Adrian Moore, <adrianrob at hotmail dot com>
45  * @author Per Cederberg, <per at percederberg dot net>
46  * @version 1.5
47  * @since 1.5
48  */
49 public class VisualBasicNamespace extends CodeElementContainer {
50
51     /**
52      * The fully qualified namespace name.
53      */
54     private String JavaDoc name;
55
56     /**
57      * Creates a new namespace.
58      *
59      * @param name the fully qualified namespace name
60      */
61     public VisualBasicNamespace(String JavaDoc name) {
62         this.name = name;
63     }
64
65     /**
66      * Returns a numeric category number for the code element. A lower
67      * category number implies that the code element should be placed
68      * before code elements with a higher category number within a
69      * declaration.
70      *
71      * @return the category number
72      */
73     public int category() {
74         return 11;
75     }
76
77     /**
78      * Adds a class declaration to the namespace.
79      *
80      * @param c the class declaration to add
81      */
82     public void addClass(VisualBasicClass c) {
83         addElement(c);
84     }
85
86     /**
87      * Adds an enumeration to the namespace.
88      *
89      * @param e the enumeration to add
90      */
91     public void addEnumeration(VisualBasicEnumeration e) {
92         addElement(e);
93     }
94
95     /**
96      * Prints the code element to the specified output stream.
97      *
98      * @param out the output stream
99      * @param style the code style to use
100      * @param indent the indentation level
101      */
102     public void print(PrintWriter JavaDoc out, CodeStyle style, int indent) {
103         String JavaDoc indentStr = style.getIndent(indent);
104
105         out.println(indentStr + "Namespace " + name );
106         out.println();
107         printContents(out, style, indent + 1);
108         out.println(indentStr + "End Namespace");
109     }
110 }
111
Popular Tags