View Javadoc

1   /*
2    $Id: AnnotatedNode.java,v 1.4 2006/01/19 00:06:51 blackdrag 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.4 $
60   */
61  public class AnnotatedNode extends ASTNode {
62      private Map annotations = new HashMap();
63      private Map annotationClasses = new HashMap();
64      private boolean synthetic;
65      ClassNode declaringClass;
66  
67      public AnnotatedNode() {
68      }
69  
70      public Map getAnnotations() {
71          return annotations;
72      }
73  
74      public AnnotationNode getAnnotations(String name) {
75          return (AnnotationNode) annotations.get(name);
76      }
77      
78      public ClassNode getAnnotationClass(String name) {
79          return (ClassNode) annotationClasses.get(name);
80      }
81  
82      public void addAnnotation(String name, AnnotationNode value) {
83          annotationClasses.put(name,value.getClassNode());
84          AnnotationNode oldValue = (AnnotationNode) annotations.get(name);
85  
86          // TODO can we support many annotations of the same name?
87          if (oldValue == null) {
88              annotations.put(name, value);
89          }
90          else {
91              List list = null;
92              if (oldValue instanceof List) {
93                  list = (List) oldValue;
94              }
95              else {
96                  list = new ArrayList();
97                  list.add(oldValue);
98                  annotations.put(name, list);
99              }
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     public ClassNode getDeclaringClass() {
121         return declaringClass;
122     }
123 
124     /***
125      * @param declaringClass The declaringClass to set.
126      */
127     public void setDeclaringClass(ClassNode declaringClass) {
128         this.declaringClass = declaringClass;
129     }
130 }