1 /*
2 $Id: AnnotatedNode.java,v 1.2 2005/04/13 11:14:21 jstrachan 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 java.util.ArrayList;
49 import java.util.HashMap;
50 import java.util.Iterator;
51 import java.util.List;
52 import java.util.Map;
53
54
55 /***
56 * Base class for any AST node which is capable of being annotationed
57 *
58 * @author <a href="mailto:jstrachan@protique.com">James Strachan</a>
59 * @version $Revision: 1.2 $
60 */
61 public class AnnotatedNode extends ASTNode {
62 private Map annotations = new HashMap();
63 private boolean synthetic;
64 ClassNode declaringClass;
65
66 public AnnotatedNode() {
67 }
68
69 public Map getAnnotations() {
70 return annotations;
71 }
72
73 public AnnotationNode getAnnotations(String name) {
74 return (AnnotationNode) annotations.get(name);
75 }
76
77 public void addAnnotation(String name, AnnotationNode value) {
78 AnnotationNode oldValue = (AnnotationNode) annotations.get(name);
79
80 // TODO can we support many annotations of the same name?
81 if (oldValue == null) {
82 annotations.put(name, value);
83 }
84 else {
85 List list = null;
86 if (oldValue instanceof List) {
87 list = (List) oldValue;
88 }
89 else {
90 list = new ArrayList();
91 list.add(oldValue);
92 annotations.put(name, list);
93 }
94 list.add(value);
95 }
96 }
97
98 public void addAnnotations(List annotations) {
99 for (Iterator iter = annotations.iterator(); iter.hasNext();) {
100 AnnotationNode node = (AnnotationNode) iter.next();
101 addAnnotation(node.getName(), node);
102 }
103
104 }
105
106 public boolean isSynthetic() {
107 return synthetic;
108 }
109
110 public void setSynthetic(boolean synthetic) {
111 this.synthetic = synthetic;
112 }
113
114 protected void addFieldsToVisitor(VariableScope scope) {
115 for (Iterator iter = getDeclaringClass().getFields().iterator(); iter.hasNext();) {
116 FieldNode field = (FieldNode) iter.next();
117 String name = field.getName();
118
119 scope.getDeclaredVariables().add(name);
120 scope.getReferencedVariables().add(name);
121 }
122 }
123
124 public ClassNode getDeclaringClass() {
125 return declaringClass;
126 }
127
128 /***
129 * @param declaringClass The declaringClass to set.
130 */
131 public void setDeclaringClass(ClassNode declaringClass) {
132 this.declaringClass = declaringClass;
133 }
134 }