View Javadoc

1   /*
2    $Id: PropertyExpression.java 4287 2006-12-01 13:00:13Z 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.expr;
47  
48  import java.lang.reflect.Field;
49  import java.lang.reflect.Method;
50  import java.lang.reflect.Modifier;
51  
52  import org.codehaus.groovy.ast.ClassHelper;
53  import org.codehaus.groovy.ast.GroovyCodeVisitor;
54  
55  /***
56   * Represents a property access such as the expression "foo.bar".
57   * 
58   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
59   * @version $Revision: 4287 $
60   */
61  public class PropertyExpression extends Expression {
62  
63      private Expression objectExpression;
64      private Expression property;
65      private boolean spreadSafe = false;
66      private boolean safe = false;
67      private boolean isStatic = false;
68  
69      private Method getter = null;
70      private Method setter = null;
71  
72      private Field field = null;
73      private int access = -1;
74      private boolean implicitThis = false;
75  
76      public boolean isStatic() {
77          return isStatic;
78      }
79  
80      public PropertyExpression(Expression objectExpression, String property) {
81          this(objectExpression, new ConstantExpression(property), false);
82      }
83      
84      public PropertyExpression(Expression objectExpression, Expression property) {
85          this(objectExpression, property, false);
86      }
87  
88      public PropertyExpression(Expression objectExpression, Expression property, boolean safe) {
89          this.objectExpression = objectExpression;
90          this.property = property;
91          this.safe = safe;
92      }
93  
94      public void visit(GroovyCodeVisitor visitor) {
95          visitor.visitPropertyExpression(this);
96      }
97  
98      public boolean isDynamic() {
99          return true;
100     }
101 
102     public Expression transformExpression(ExpressionTransformer transformer) {
103         return this;
104     }
105 
106     public Expression getObjectExpression() {
107         return objectExpression;
108     }
109 
110     public void setObjectExpression(Expression exp) {
111         objectExpression=exp;
112     }    
113     
114     public Expression getProperty() {
115         return property;
116     }
117     
118     public String getPropertyAsString() {
119         if (property==null) return null;
120         if (! (property instanceof ConstantExpression)) return null;
121         ConstantExpression constant = (ConstantExpression) property;
122         return constant.getText();
123     }
124 
125     public String getText() {
126         return objectExpression.getText() + "." + property.getText();
127     }
128 
129     /***
130      * @return is this a safe navigation, i.e. if true then if the source object is null
131      * then this navigation will return null
132      */
133     public boolean isSafe() {
134         return safe;
135     }
136 
137     public boolean isSpreadSafe() {
138         return spreadSafe;
139     }
140 
141     public void setSpreadSafe(boolean value) {
142         spreadSafe = value;
143     }
144 
145     public String toString() {
146         return super.toString() + "[object: " + objectExpression + " property: " + property + "]";
147     }
148 
149     public void setStatic(boolean aStatic) {
150         this.isStatic = aStatic;
151     }
152 
153     public Method getGetter() {
154         return getter;
155     }
156 
157     public Method getSetter() {
158         return setter;
159     }
160 
161     public void setField(Field fld) {
162         field = fld;
163         setStatic(Modifier.isStatic(fld.getModifiers()));
164         setType(ClassHelper.make(fld.getType()));
165     }
166     
167     public Field getField() {
168         return field;
169     }
170 
171     public void setAccess(int access) {
172         this.access = access;
173     }
174 
175     public int getAccess() {
176         return access;
177     }
178     
179     public boolean isImplicitThis(){
180         return implicitThis;
181     }
182     
183     public void setImplicitThis(boolean it) {
184         implicitThis  = it;
185     }
186 }