001    /*
002     $Id: Parameter.java 3840 2006-06-15 17:21:33Z blackdrag $
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 org.codehaus.groovy.ast.expr.*;
049    
050    /**
051     * Represents a parameter on a constructor or method call. The type name is
052     * optional - it should be defaulted to java.lang.Object if unknown.
053     * 
054     * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
055     * @version $Revision: 3840 $
056     */
057    public class Parameter implements Variable {
058    
059        public static final Parameter[] EMPTY_ARRAY = {
060        };
061    
062        private ClassNode type;
063        private String name;
064        private boolean dynamicTyped;
065        private Expression defaultValue;
066        private boolean hasDefaultValue;
067        private boolean inStaticContext;
068        private boolean closureShare=false;
069    
070        public Parameter(ClassNode type, String name) {
071            this.name = name;
072            this.setType(type);
073            this.hasDefaultValue = false;
074        }
075        
076        public Parameter(ClassNode type, String name, Expression defaultValue) {
077            this(type,name);
078            this.defaultValue = defaultValue;
079            this.hasDefaultValue = true;
080        }
081    
082        public String toString() {
083            return super.toString() + "[name:" + name + ((type == null) ? "" : " type: " + type.getName()) + ", hasDefaultValue: " + this.hasInitialExpression() + "]";
084        }
085    
086        public String getName() {
087            return name;
088        }
089    
090        public ClassNode getType() {
091            return type;
092        }
093    
094        public void setType(ClassNode type) {
095            this.type = type;
096            dynamicTyped |= type==ClassHelper.DYNAMIC_TYPE;
097        }
098        
099        public boolean hasInitialExpression() {
100            return this.hasDefaultValue;
101        }
102        
103        /**
104         * @return the default value expression for this parameter or null if
105         * no default value is specified
106         */
107        public Expression getInitialExpression() {
108            return defaultValue;
109        }
110        
111        public void setInitialExpression(Expression init) {
112            defaultValue = init;
113        }
114        
115        public boolean isInStaticContext() {
116            return inStaticContext;
117        }
118        
119        public void setInStaticContext(boolean inStaticContext) {
120            this.inStaticContext = inStaticContext;
121        }
122    
123        public boolean isDynamicTyped() {
124            return dynamicTyped;
125        }
126    
127        public boolean isClosureSharedVariable() {
128            return closureShare;
129        }
130    
131        public void setClosureSharedVariable(boolean inClosure) {
132            closureShare = inClosure;        
133        }
134    }