View Javadoc

    1   /*
    2    $Id: Parameter.java,v 1.17 2006/06/15 17:21:33 blackdrag 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 org.codehaus.groovy.ast.expr.*;
    49
    50  /***
    51   * Represents a parameter on a constructor or method call. The type name is
    52   * optional - it should be defaulted to java.lang.Object if unknown.
    53   *
    54   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
    55   * @version $Revision: 1.17 $
    56   */
    57  public class Parameter implements Variable {
    58
    59      public static final Parameter[] EMPTY_ARRAY = {
    60      };
    61
    62      private ClassNode type;
    63      private String name;
    64      private boolean dynamicTyped;
    65      private Expression defaultValue;
    66      private boolean hasDefaultValue;
    67      private boolean inStaticContext;
    68      private boolean closureShare=false;
    69
    70      public Parameter(ClassNode type, String name) {
    71          this.name = name;
    72          this.setType(type);
    73          this.hasDefaultValue = false;
    74      }
    75
    76      public Parameter(ClassNode type, String name, Expression defaultValue) {
    77          this(type,name);
    78          this.defaultValue = defaultValue;
    79          this.hasDefaultValue = true;
    80      }
    81
    82      public String toString() {
    83          return super.toString() + "[name:" + name + ((type == null) ? "" : " type: " + type.getName()) + ", hasDefaultValue: " + this.hasInitialExpression() + "]";
    84      }
    85
    86      public String getName() {
    87          return name;
    88      }
    89
    90      public ClassNode getType() {
    91          return type;
    92      }
    93
    94      public void setType(ClassNode type) {
    95          this.type = type;
    96          dynamicTyped |= type==ClassHelper.DYNAMIC_TYPE;
    97      }
    98
    99      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 }