KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jruby > ast > ClassNode


1 /***** BEGIN LICENSE BLOCK *****
2  * Version: CPL 1.0/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Common Public
5  * License Version 1.0 (the "License"); you may not use this file
6  * except in compliance with the License. You may obtain a copy of
7  * the License at http://www.eclipse.org/legal/cpl-v10.html
8  *
9  * Software distributed under the License is distributed on an "AS
10  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
11  * implied. See the License for the specific language governing
12  * rights and limitations under the License.
13  *
14  * Copyright (C) 2001-2002 Jan Arne Petersen <jpetersen@uni-bonn.de>
15  * Copyright (C) 2001-2002 Benoit Cerrina <b.cerrina@wanadoo.fr>
16  * Copyright (C) 2002 Anders Bengtsson <ndrsbngtssn@yahoo.se>
17  * Copyright (C) 2004 Thomas E Enebo <enebo@acm.org>
18  *
19  * Alternatively, the contents of this file may be used under the terms of
20  * either of the GNU General Public License Version 2 or later (the "GPL"),
21  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
22  * in which case the provisions of the GPL or the LGPL are applicable instead
23  * of those above. If you wish to allow use of your version of this file only
24  * under the terms of either the GPL or the LGPL, and not to allow others to
25  * use your version of this file under the terms of the CPL, indicate your
26  * decision by deleting the provisions above and replace them with the notice
27  * and other provisions required by the GPL or the LGPL. If you do not delete
28  * the provisions above, a recipient may use your version of this file under
29  * the terms of any one of the CPL, the GPL or the LGPL.
30  ***** END LICENSE BLOCK *****/
31 package org.jruby.ast;
32
33 import java.util.List JavaDoc;
34
35 import org.jruby.ast.visitor.NodeVisitor;
36 import org.jruby.evaluator.Instruction;
37 import org.jruby.lexer.yacc.ISourcePosition;
38 import org.jruby.parser.StaticScope;
39
40 /**
41  * A class statement.
42  * A class statement is defined by its name, its supertype and its body.
43  * The body is a separate naming scope.
44  * This node is for a regular class definition, Singleton classes get their own
45  * node, the SClassNode
46  *
47  * @author jpetersen
48  */
49 public class ClassNode extends Node implements IScopingNode {
50     static final long serialVersionUID = -1369424045737867587L;
51
52     private final Colon3Node cpath;
53     private final StaticScope scope;
54     private final Node bodyNode;
55     private final Node superNode;
56     
57     public ClassNode(ISourcePosition position, Colon3Node cpath, StaticScope scope, Node bodyNode, Node superNode) {
58         super(position, NodeTypes.CLASSNODE);
59         this.cpath = cpath;
60         this.scope = scope;
61         this.bodyNode = bodyNode;
62         this.superNode = superNode;
63     }
64
65     /**
66      * Accept for the visitor pattern.
67      * @param iVisitor the visitor
68      **/
69     public Instruction accept(NodeVisitor iVisitor) {
70         return iVisitor.visitClassNode(this);
71     }
72     
73     /**
74      * Gets the body of this class.
75      *
76      * @return the contents
77      */
78     public Node getBodyNode() {
79         return bodyNode;
80     }
81     
82     /**
83      * Get the static scoping information.
84      *
85      * @return the scoping info
86      */
87     public StaticScope getScope() {
88         return scope;
89     }
90
91     /**
92      * Gets the className.
93      * @return Returns representation of class path+name
94      */
95     public Colon3Node getCPath() {
96         return cpath;
97     }
98
99     /**
100      * Gets the superNode.
101      * @return Returns a Node
102      */
103     public Node getSuperNode() {
104         return superNode;
105     }
106
107     public List JavaDoc childNodes() {
108         return Node.createList(cpath, bodyNode, superNode);
109     }
110     
111     public String JavaDoc toString() {
112         return "ClassNode [" + cpath + "]";
113     }
114
115 }
116
Popular Tags