001 /*
002 $Id: Parameter.java,v 1.11 2004/07/10 03:31:38 bran Exp $
003
004 Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
005
006 Redistribution and use of this software and associated documentation
007 ("Software"), with or without modification, are permitted provided
008 that the following conditions are met:
009
010 1. Redistributions of source code must retain copyright
011 statements and notices. Redistributions must also contain a
012 copy of this document.
013
014 2. Redistributions in binary form must reproduce the
015 above copyright notice, this list of conditions and the
016 following disclaimer in the documentation and/or other
017 materials provided with the distribution.
018
019 3. The name "groovy" must not be used to endorse or promote
020 products derived from this Software without prior written
021 permission of The Codehaus. For written permission,
022 please contact info@codehaus.org.
023
024 4. Products derived from this Software may not be called "groovy"
025 nor may "groovy" appear in their names without prior written
026 permission of The Codehaus. "groovy" is a registered
027 trademark of The Codehaus.
028
029 5. Due credit should be given to The Codehaus -
030 http://groovy.codehaus.org/
031
032 THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
033 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
034 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
035 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
036 THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
037 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
038 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
039 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
040 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
041 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
042 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
043 OF THE POSSIBILITY OF SUCH DAMAGE.
044
045 */
046 package org.codehaus.groovy.ast;
047
048 import groovy.lang.Reference;
049
050 import org.codehaus.groovy.ast.expr.*;
051
052 /**
053 * Represents a parameter on a constructor or method call. The type name is
054 * optional - it should be defaulted to java.lang.Object if unknown.
055 *
056 * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
057 * @version $Revision: 1.11 $
058 */
059 public class Parameter {
060
061 public static final Parameter[] EMPTY_ARRAY = {
062 };
063
064 private String type;
065 private String name;
066 private boolean dynamicType;
067 private Expression defaultValue;
068 private String realType;
069
070 public Parameter(String name) {
071 this(null, name);
072 }
073
074 public Parameter(String type, String name) {
075 this(type, name, null);
076 }
077
078 public Parameter(String type, String name, Expression defaultValue) {
079 this.name = MethodNode.ensureJavaTypeNameSyntax(name);
080 this.type = type;
081 this.defaultValue = defaultValue;
082 if (type == null || type.length() == 0) {
083 this.type = "java.lang.Object";
084 this.dynamicType = true;
085 }
086 }
087
088 public String toString() {
089 return super.toString() + "[name:" + name + ((type == null) ? "" : " type: " + type) + "]";
090 }
091
092 public String getName() {
093 return name;
094 }
095
096 public String getType() {
097 return type;
098 }
099
100 public void setType(String type) {
101 this.type = type;
102 }
103
104 public boolean isDynamicType() {
105 return dynamicType;
106 }
107
108 /**
109 * @return the default value expression for this parameter or null if
110 * no default value is specified
111 */
112 public Expression getDefaultValue() {
113 return defaultValue;
114 }
115
116 public void makeReference() {
117 realType = type;
118 type = Reference.class.getName();
119 }
120
121 /**
122 * @return the real logical type if a dereference is being made
123 * (e.g. to share variables across closure scopes)
124 */
125 public String getRealType() {
126 return realType;
127 }
128
129 }