001    /*
002    $Id: Variable.java 3419 2006-01-19 00:07:02Z 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.Expression;
049    
050    /**
051     * interface to mark a AstNode as Variable. Typically these are 
052     * VariableExpression, FieldNode, PropertyNode and Parameter
053     * 
054     * @author Jochen Theodorou
055     */
056    public interface Variable {
057        
058        /**
059         * the type of the variable
060         */
061        public ClassNode getType();
062        
063        /**
064         * the name of the variable
065         */
066        public String getName();
067        
068        /**
069         * expression used to initialize the variable or null of there
070         * is no initialization.
071         */
072        public Expression getInitialExpression();
073        
074        /**
075         * returns true if there is an initialization expression
076         */
077        public boolean hasInitialExpression();
078        
079        /**
080         * returns true if this variable is used in a static context.
081         * A static context is any static initializer block, when this variable
082         * is declared as static or when this variable is used in a static method 
083         */
084        public boolean isInStaticContext();
085    
086        public boolean isDynamicTyped();
087        public boolean isClosureSharedVariable();
088        public void setClosureSharedVariable(boolean inClosure);
089        
090    }