001    /*
002     $Id: AnnotatedNode.java,v 1.3 2005/11/13 16:42:09 blackdrag 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.3 $
060     */
061    public class AnnotatedNode extends ASTNode {
062        private Map annotations = new HashMap();
063        private Map annotationClasses = new HashMap();
064        private boolean synthetic;
065        ClassNode declaringClass;
066    
067        public AnnotatedNode() {
068        }
069    
070        public Map getAnnotations() {
071            return annotations;
072        }
073    
074        public AnnotationNode getAnnotations(String name) {
075            return (AnnotationNode) annotations.get(name);
076        }
077        
078        public ClassNode getAnnotationClass(String name) {
079            return (ClassNode) annotationClasses.get(name);
080        }
081    
082        public void addAnnotation(String name, AnnotationNode value) {
083            annotationClasses.put(name,value.getClassNode());
084            AnnotationNode oldValue = (AnnotationNode) annotations.get(name);
085    
086            // TODO can we support many annotations of the same name?
087            if (oldValue == null) {
088                annotations.put(name, value);
089            }
090            else {
091                List list = null;
092                if (oldValue instanceof List) {
093                    list = (List) oldValue;
094                }
095                else {
096                    list = new ArrayList();
097                    list.add(oldValue);
098                    annotations.put(name, list);
099                }
100                list.add(value);
101            }
102        }
103    
104        public void addAnnotations(List annotations) {
105            for (Iterator iter = annotations.iterator(); iter.hasNext();) {
106                AnnotationNode node = (AnnotationNode) iter.next();
107                addAnnotation(node.getClassNode().getName(), node);
108            }
109    
110        }
111    
112        public boolean isSynthetic() {
113            return synthetic;
114        }
115    
116        public void setSynthetic(boolean synthetic) {
117            this.synthetic = synthetic;
118        }
119    
120        protected void addFieldsToVisitor(VariableScope scope) {
121            for (Iterator iter = getDeclaringClass().getFields().iterator(); iter.hasNext();) {
122                FieldNode field = (FieldNode) iter.next();
123                String name = field.getName();
124    
125                scope.getDeclaredVariables().add(name);
126                scope.getReferencedVariables().add(name);
127            }
128        }
129    
130        public ClassNode getDeclaringClass() {
131            return declaringClass;
132        }
133    
134        /**
135         * @param declaringClass The declaringClass to set.
136         */
137        public void setDeclaringClass(ClassNode declaringClass) {
138            this.declaringClass = declaringClass;
139        }
140    }