View Javadoc

1   /*
2    $Id: Parameter.java,v 1.12 2005/07/16 20:00:26 phk Exp $
3   
4    Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5   
6    Redistribution and use of this software and associated documentation
7    ("Software"), with or without modification, are permitted provided
8    that the following conditions are met:
9   
10   1. Redistributions of source code must retain copyright
11      statements and notices.  Redistributions must also contain a
12      copy of this document.
13  
14   2. Redistributions in binary form must reproduce the
15      above copyright notice, this list of conditions and the
16      following disclaimer in the documentation and/or other
17      materials provided with the distribution.
18  
19   3. The name "groovy" must not be used to endorse or promote
20      products derived from this Software without prior written
21      permission of The Codehaus.  For written permission,
22      please contact info@codehaus.org.
23  
24   4. Products derived from this Software may not be called "groovy"
25      nor may "groovy" appear in their names without prior written
26      permission of The Codehaus. "groovy" is a registered
27      trademark of The Codehaus.
28  
29   5. Due credit should be given to The Codehaus -
30      http://groovy.codehaus.org/
31  
32   THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
33   ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
34   NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
35   FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
36   THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
43   OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45   */
46  package org.codehaus.groovy.ast;
47  
48  import groovy.lang.Reference;
49  
50  import org.codehaus.groovy.ast.expr.*;
51  
52  /***
53   * Represents a parameter on a constructor or method call. The type name is
54   * optional - it should be defaulted to java.lang.Object if unknown.
55   * 
56   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
57   * @version $Revision: 1.12 $
58   */
59  public class Parameter {
60  
61      public static final Parameter[] EMPTY_ARRAY = {
62      };
63  
64      private String type;
65      private String name;
66      private boolean dynamicType;
67      private Expression defaultValue;
68      private String realType;
69      final private boolean hasDefaultValue;
70  
71      public Parameter(String name) {
72          this.name = null;
73          this.hasDefaultValue = false;
74          this.type = "java.lang.Object";
75          this.dynamicType = true;
76      }
77  
78      public Parameter(String type, String name) {
79          this.name = MethodNode.ensureJavaTypeNameSyntax(name);
80          this.type = type;
81          this.hasDefaultValue = false;
82          if (type == null || type.length() == 0) {
83              this.type = "java.lang.Object";
84              this.dynamicType = true;
85          }
86      }
87  
88      public Parameter(String type, String name, Expression defaultValue) {
89          this.name = MethodNode.ensureJavaTypeNameSyntax(name);
90          this.type = type;
91          this.defaultValue = defaultValue;
92          this.hasDefaultValue = true;
93          if (type == null || type.length() == 0) {
94              this.type = "java.lang.Object";
95              this.dynamicType = true;
96          }
97      }
98  
99      public String toString() {
100         return super.toString() + "[name:" + name + ((type == null) ? "" : " type: " + type) + ", hasDefaultValue: " + this.hasDefaultValue() + "]";
101     }
102 
103     public String getName() {
104         return name;
105     }
106 
107     public String getType() {
108         return type;
109     }
110 
111     public void setType(String type) {
112         this.type = type;
113     }
114 
115     public boolean isDynamicType() {
116         return dynamicType;
117     }
118     
119     public boolean hasDefaultValue() {
120         return this.hasDefaultValue;
121     }
122     
123     /***
124      * @return the default value expression for this parameter or null if
125      * no default value is specified
126      */
127     public Expression getDefaultValue() {
128         return defaultValue;
129     }
130 
131     public void makeReference() {
132         realType = type;
133         type = Reference.class.getName();
134     }
135     
136     /***
137      * @return the real logical type if a dereference is being made 
138      * (e.g. to share variables across closure scopes)
139      */
140     public String getRealType() {
141         return realType;
142     }
143 
144 }