001    /*
002     $Id: Parameter.java,v 1.12 2005/07/16 20:00:26 phk 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.12 $
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        final private boolean hasDefaultValue;
070    
071        public Parameter(String name) {
072            this.name = null;
073            this.hasDefaultValue = false;
074            this.type = "java.lang.Object";
075            this.dynamicType = true;
076        }
077    
078        public Parameter(String type, String name) {
079            this.name = MethodNode.ensureJavaTypeNameSyntax(name);
080            this.type = type;
081            this.hasDefaultValue = false;
082            if (type == null || type.length() == 0) {
083                this.type = "java.lang.Object";
084                this.dynamicType = true;
085            }
086        }
087    
088        public Parameter(String type, String name, Expression defaultValue) {
089            this.name = MethodNode.ensureJavaTypeNameSyntax(name);
090            this.type = type;
091            this.defaultValue = defaultValue;
092            this.hasDefaultValue = true;
093            if (type == null || type.length() == 0) {
094                this.type = "java.lang.Object";
095                this.dynamicType = true;
096            }
097        }
098    
099        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    }