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 org.exolab.castor.xml.ValidationException;
39
40 import java.util.Enumeration;
41 import java.util.Vector;
42
43 /**
44 * A class representing the XML Schema Annotation.
45 *
46 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
47 * @version $Revision$ $Date: 2005-12-13 14:58:48 -0700 (Tue, 13 Dec 2005) $
48 **/
49 public class Annotation extends Structure {
50 /** SerialVersionUID */
51 private static final long serialVersionUID = 2838816224303555598L;
52
53 /**
54 * List of {@literal <appinfo/>} objects.
55 **/
56 private final Vector<AppInfo> _appInfos = new Vector<>();
57
58 /**
59 * List of <documentation/> objects.
60 **/
61 private final Vector<Documentation> _documentations = new Vector<>();
62
63 /**
64 * Adds the given {@link AppInfo} to this annotation.
65 *
66 * @param appInfo the AppInfo to add
67 **/
68 public void addAppInfo(final AppInfo appInfo) {
69 if (appInfo != null) {
70 _appInfos.add(appInfo);
71 }
72 }
73
74 /**
75 * Adds the given Documentation to this Annotation.
76 *
77 * @param documentation the documentation to add to this Annotation
78 **/
79 public void addDocumentation(final Documentation documentation) {
80 if (documentation != null) {
81 _documentations.add(documentation);
82 }
83 }
84
85 /**
86 * Returns an enumeration of all {@link AppInfo} elements for this Annotation.
87 *
88 * @return an enumeration of all {@link AppInfo} elements for this Annotation
89 **/
90 public Enumeration<AppInfo> getAppInfo() {
91 return _appInfos.elements();
92 }
93
94 /**
95 * Returns an enumeration of all documentation elements for this Annotation.
96 *
97 * @return an enumeration of all documentation elements for this Annotation
98 **/
99 public Enumeration<Documentation> getDocumentation() {
100 return _documentations.elements();
101 }
102
103 /**
104 * Removes the given AppInfo from this Annotation.
105 *
106 * @param appInfo the AppInfo to remove
107 **/
108 public void removeAppInfo(final AppInfo appInfo) {
109 if (appInfo != null) {
110 _appInfos.remove(appInfo);
111 }
112 }
113
114 /**
115 * Removes the given {@link Documentation} from this Annotation.
116 *
117 * @param documentation the Documentation to remove
118 **/
119 public void removeDocumentation(final Documentation documentation) {
120 if (documentation != null) {
121 _documentations.remove(documentation);
122 }
123 }
124
125 /**
126 * Returns the type of this Schema Structure.
127 *
128 * @return the type of this Schema Structure
129 **/
130 public short getStructureType() {
131 return Structure.ANNOTATION;
132 }
133
134 /**
135 * Checks the validity of this Schema definition.
136 *
137 * @exception ValidationException when this Schema definition is invalid.
138 **/
139 public void validate() throws ValidationException {
140 // -- do nothing
141 }
142
143 }