001 /*
002 $Id: AnnotatedNode.java,v 1.2 2005/04/13 11:14:21 jstrachan Exp $
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 java.util.ArrayList;
049 import java.util.HashMap;
050 import java.util.Iterator;
051 import java.util.List;
052 import java.util.Map;
053
054
055 /**
056 * Base class for any AST node which is capable of being annotationed
057 *
058 * @author <a href="mailto:jstrachan@protique.com">James Strachan</a>
059 * @version $Revision: 1.2 $
060 */
061 public class AnnotatedNode extends ASTNode {
062 private Map annotations = new HashMap();
063 private boolean synthetic;
064 ClassNode declaringClass;
065
066 public AnnotatedNode() {
067 }
068
069 public Map getAnnotations() {
070 return annotations;
071 }
072
073 public AnnotationNode getAnnotations(String name) {
074 return (AnnotationNode) annotations.get(name);
075 }
076
077 public void addAnnotation(String name, AnnotationNode value) {
078 AnnotationNode oldValue = (AnnotationNode) annotations.get(name);
079
080 // TODO can we support many annotations of the same name?
081 if (oldValue == null) {
082 annotations.put(name, value);
083 }
084 else {
085 List list = null;
086 if (oldValue instanceof List) {
087 list = (List) oldValue;
088 }
089 else {
090 list = new ArrayList();
091 list.add(oldValue);
092 annotations.put(name, list);
093 }
094 list.add(value);
095 }
096 }
097
098 public void addAnnotations(List annotations) {
099 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 }