1 /**
2 * Redistribution and use of this software and associated documentation ("Software"), with or
3 * without modification, are permitted provided that the following conditions are met:
4 *
5 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6 * must also contain a copy of this document.
7 *
8 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9 * conditions and the following disclaimer in the documentation and/or other materials provided with
10 * the distribution.
11 *
12 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13 * without prior written permission of Intalio, Inc. For written permission, please contact
14 * info@exolab.org.
15 *
16 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18 * Intalio, Inc.
19 *
20 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21 *
22 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35
36 package org.exolab.castor.xml.schema;
37
38 import java.util.Enumeration;
39 import java.util.Vector;
40
41 /**
42 * A base class used for XML Structures that support annotations.
43 *
44 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
45 * @version $Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
46 **/
47 public abstract class Annotated extends Structure {
48
49 /**
50 * The Annotations of this Annotated structure.
51 **/
52 private final Vector<Annotation> _annotations = new Vector<Annotation>(1);
53
54 /**
55 * Adds the given Annotation to this Annotated Structure.
56 *
57 * @param annotation the Annotation to add
58 **/
59 public void addAnnotation(final Annotation annotation) {
60 _annotations.add(annotation);
61 }
62
63 /**
64 * Returns an Enumeration of the Annotations contained within this Annotated type.
65 *
66 * @return an Enumeration of the Annotation contained within this Annotated type
67 **/
68 public Enumeration<Annotation> getAnnotations() {
69 return _annotations.elements();
70 }
71
72 /**
73 * Removes the given Annotation from this Annotated Structure.
74 *
75 * @param annotation the Annotation to remove
76 **/
77 public void removeAnnotation(final Annotation annotation) {
78 _annotations.remove(annotation);
79 }
80
81 }