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-2000 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35
36 package org.exolab.castor.xml.schema;
37
38
39 import java.util.StringTokenizer;
40
41 /**
42 * A class to represent the values of the XML Schema block property
43 *
44 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
45 * @version $Revision$ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $
46 **/
47 public final class BlockList {
48
49 /**
50 * The #all value
51 **/
52 public static final String ALL = "#all";
53
54 /**
55 * The extension value
56 **/
57 public static final String EXTENSION = "extension";
58
59 /**
60 * The restriction value
61 **/
62 public static final String RESTRICTION = "restriction";
63
64 /**
65 * The substitution value
66 **/
67 public static final String SUBSTITUTION = "substitution";
68
69 private boolean _all = false;
70
71 /**
72 * Flag for blocking extensions
73 **/
74 private boolean _extension = false;
75
76 /**
77 * Flag for blocking restrictions
78 **/
79 private boolean _restriction = false;
80
81 /**
82 * Flag for blocking substitutions
83 **/
84 private boolean _substitution = false;
85
86 /**
87 * Creates a new default BlockList. Nothing is flagged as being blocked.
88 **/
89 public BlockList() {
90 super();
91 } // -- BlockList
92
93 /**
94 * Creates a new BlockList using the given list of values.
95 *
96 * @param listOfValues the list of block values
97 * @exception IllegalArgumentException if the list of values contains something other than
98 * "extension", "restriction", or "substition".
99 **/
100 public BlockList(String listOfValues) {
101
102 super();
103
104 if (listOfValues != null) {
105 parseValues(listOfValues);
106 }
107
108 } // -- listOfValues.
109
110 /**
111 * Returns true if the BlockList contains "#all".
112 *
113 * @return true if the BlockList contains "#all".
114 **/
115 public boolean hasAll() {
116 return _all;
117 } // -- hasAll
118
119 /**
120 * Returns true if extension is contained within this BlockList.
121 *
122 * @return true if extension is contained within this BlockList.
123 **/
124 public boolean hasExtension() {
125 return _extension;
126 } // -- hasExtension
127
128 /**
129 * Returns true if restriction is contained within this BlockList.
130 *
131 * @return true if restriction is contained within this BlockList
132 **/
133 public boolean hasRestriction() {
134 return _restriction;
135 } // -- hasRestriction
136
137 /**
138 * Returns true if substitution is contained within this BlockList.
139 *
140 * @return true if substitution is contained within this BlockList.
141 **/
142 public boolean hasSubstitution() {
143 return _substitution;
144 } // -- hasSubstitution
145
146 /**
147 * Returns the String representation of this BlockList
148 **/
149 public String toString() {
150 if (_all) {
151 return ALL;
152 }
153 StringBuffer value = new StringBuffer();
154 if (_extension) {
155 value.append(EXTENSION);
156 }
157 if (_restriction) {
158 if (value.length() > 0) {
159 value.append(' ');
160 }
161 value.append(RESTRICTION);
162 }
163 if (_substitution) {
164 if (value.length() > 0) {
165 value.append(' ');
166 }
167 value.append(RESTRICTION);
168 }
169 return value.toString();
170 } // -- toString
171
172 // -------------------/
173 // - Private Methods -/
174 // -------------------/
175
176 /**
177 * Parses the given values and sets the appropriate flags for this BlockList.
178 *
179 * @param values the list of Block values.
180 **/
181 private void parseValues(String values) {
182
183 if (ALL.equals(values)) {
184 _all = true;
185 return;
186 }
187
188 StringTokenizer tokenizer = new StringTokenizer(values);
189
190 while (tokenizer.hasMoreTokens()) {
191 String value = tokenizer.nextToken();
192
193 if (EXTENSION.equals(value)) {
194 _extension = true;
195 } else if (RESTRICTION.equals(value)) {
196 _restriction = true;
197 } else if (SUBSTITUTION.equals(value)) {
198 _substitution = true;
199 } else {
200 String err = "invalid block list: " + values;
201 throw new IllegalArgumentException(err);
202 }
203 }
204
205 } // -- parseValues
206
207 } // -- class: BlockList