View Javadoc

    1   /*
    2   $Id: Variable.java 3419 2006-01-19 00:07:02Z blackdrag $
    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.Expression;
    49
    50  /***
    51   * interface to mark a AstNode as Variable. Typically these are
    52   * VariableExpression, FieldNode, PropertyNode and Parameter
    53   *
    54   * @author Jochen Theodorou
    55   */
    56  public interface Variable {
    57
    58      /***
    59       * the type of the variable
    60       */
    61      public ClassNode getType();
    62
    63      /***
    64       * the name of the variable
    65       */
    66      public String getName();
    67
    68      /***
    69       * expression used to initialize the variable or null of there
    70       * is no initialization.
    71       */
    72      public Expression getInitialExpression();
    73
    74      /***
    75       * returns true if there is an initialization expression
    76       */
    77      public boolean hasInitialExpression();
    78
    79      /***
    80       * returns true if this variable is used in a static context.
    81       * A static context is any static initializer block, when this variable
    82       * is declared as static or when this variable is used in a static method
    83       */
    84      public boolean isInStaticContext();
    85
    86      public boolean isDynamicTyped();
    87      public boolean isClosureSharedVariable();
    88      public void setClosureSharedVariable(boolean inClosure);
    89
    90  }