1 /**
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2001-2002 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id: JAnnotatedElementHelper
44 */
45 package org.exolab.javasource;
46
47 import java.util.Iterator;
48 import java.util.LinkedHashMap;
49
50 /**
51 * Implements JAnnotatedElement interface on behalf of other classes in this
52 * package that implement this interface.
53 *
54 * @author <a href="mailto:andrew DOT fawcett AT coda DOTcom">Andrew Fawcett</a>
55 * @version $Revision$ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $
56 */
57 public class JAnnotatedElementHelper implements JAnnotatedElement {
58
59 /**
60 * Stores annotations associated with the source element containing this helper.
61 */
62 private LinkedHashMap<String, JAnnotation> _annotations =
63 new LinkedHashMap<String, JAnnotation>();
64
65 /**
66 * Creates a JAnnodatedElementHelper.
67 */
68 public JAnnotatedElementHelper() {
69 super();
70 }
71
72 /**
73 * {@inheritDoc}
74 */
75 public final JAnnotation getAnnotation(final JAnnotationType annotationType) {
76 if (_annotations == null) { return null; }
77 return _annotations.get(annotationType.getName());
78 }
79
80 /**
81 * {@inheritDoc}
82 */
83 public final JAnnotation[] getAnnotations() {
84 return _annotations.values().toArray(new JAnnotation[_annotations.size()]);
85 }
86
87 /**
88 * {@inheritDoc}
89 */
90 public final boolean isAnnotationPresent(final JAnnotationType annotationType) {
91 return _annotations.containsKey(annotationType.getName());
92 }
93
94 /**
95 * {@inheritDoc}
96 */
97 public final void addAnnotation(final JAnnotation annotation) {
98 if (isAnnotationPresent(annotation.getAnnotationType())) {
99 throw new IllegalArgumentException(
100 "Annotation for '" + annotation.getAnnotationType().getName()
101 + "' already added.");
102 }
103 String annotationType = annotation.getAnnotationType().getName();
104 _annotations.put(annotationType, annotation);
105 }
106
107 /**
108 * {@inheritDoc}
109 */
110 public final JAnnotation removeAnnotation(final JAnnotationType annotationType) {
111 if (!isAnnotationPresent(annotationType)) {
112 throw new IllegalArgumentException(
113 "Annotation for '" + annotationType.getName() + "' not present.");
114 }
115 return _annotations.remove(annotationType.getName());
116 }
117
118 /**
119 * {@inheritDoc}
120 */
121 public final boolean hasAnnotations() {
122 return _annotations.size() > 0;
123 }
124
125 /**
126 * Outputs the list of annotations maintained by this object.
127 *
128 * @param jsw the JSourceWriter to print the annotations to
129 * @return true if at least one annotation was printed, false otherwise.
130 */
131 public final boolean printAnnotations(final JSourceWriter jsw) {
132 boolean printed = false;
133 Iterator<JAnnotation> annotations = _annotations.values().iterator();
134 while (annotations.hasNext()) {
135 JAnnotation annotation = annotations.next();
136 annotation.print(jsw);
137 jsw.writeln();
138 printed = true;
139 }
140 return printed;
141 }
142
143 }