KickJava   Java API By Example, From Geeks To Geeks.

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


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.types.INameNode;
36 import org.jruby.ast.visitor.NodeVisitor;
37 import org.jruby.evaluator.Instruction;
38 import org.jruby.lexer.yacc.ISourcePosition;
39
40 /**
41  * a block argument.
42  * A block argument, when present in a function declaration is the last argument
43  * and it is preceded by an ampersand:<br>
44  *
45  * <code>def tutu(a, b, &amp;c)</code>
46  * in this example c is a BlockArgNode
47  * @author jpetersen
48  */
49 public class BlockArgNode extends Node implements INameNode {
50     static final long serialVersionUID = 8374824536805365398L;
51
52     private final int count;
53     private String JavaDoc name;
54
55     public BlockArgNode(ISourcePosition position, int count, String JavaDoc name) {
56         super(position, NodeTypes.BLOCKARGNODE);
57         this.count = count;
58         this.name = name;
59     }
60
61     /**
62      * Accept for the visitor pattern.
63      * @param iVisitor the visitor
64      **/
65     public Instruction accept(NodeVisitor iVisitor) {
66         return iVisitor.visitBlockArgNode(this);
67     }
68
69     /**
70      * Gets the count.
71      * @return Returns a int
72      */
73     public int getCount() {
74         return count;
75     }
76
77     /**
78      * Get the name of this block argument
79      *
80      * @return it's name
81      */
82     public String JavaDoc getName() {
83         return name;
84     }
85
86     public void setName(String JavaDoc name) {
87         this.name = name;
88     }
89     
90     public List JavaDoc childNodes() {
91         return EMPTY_LIST;
92     }
93
94 }
95
Popular Tags