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 FinalList {
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 private boolean _all = false;
66
67 /**
68 * Flag for blocking extensions
69 **/
70 private boolean _extension = false;
71
72 /**
73 * Flag for blocking restrictions
74 **/
75 private boolean _restriction = false;
76
77 /**
78 * Creates a new default FinalList. Nothing is flagged as being final.
79 **/
80 public FinalList() {
81 super();
82 } // -- FinalList
83
84 /**
85 * Creates a new FinalList using the given list of values.
86 *
87 * @param listOfValues the list of final values
88 * @exception IllegalArgumentException if the list of values contains something other than "#all",
89 * "extension", "restriction".
90 **/
91 public FinalList(String listOfValues) {
92
93 super();
94
95 if (listOfValues != null) {
96 parseValues(listOfValues);
97 }
98
99 } // -- FinalList
100
101 /**
102 * Returns true if the FinalList contains "#all".
103 *
104 * @return true if the FinalList contains "#all".
105 **/
106 public boolean hasAll() {
107 return _all;
108 } // -- hasAll
109
110 /**
111 * Returns true if extension is contained within this FinalList.
112 *
113 * @return true if extension is contained within this FinalList.
114 **/
115 public boolean hasExtension() {
116 return _extension;
117 } // -- hasExtension
118
119 /**
120 * Returns true if restriction is contained within this FinalList.
121 *
122 * @return true if restriction is contained within this FinalList.
123 **/
124 public boolean hasRestriction() {
125 return _restriction;
126 } // -- hasRestriction
127
128 /**
129 * Returns the String representation of this FinalList.
130 *
131 * @return the String representation of this FinalList.
132 **/
133 public String toString() {
134 if (_all)
135 return ALL;
136
137 StringBuffer value = new StringBuffer();
138 if (_extension) {
139 value.append(EXTENSION);
140 }
141 if (_restriction) {
142 if (value.length() > 0) {
143 value.append(' ');
144 }
145 value.append(RESTRICTION);
146 }
147 return value.toString();
148 } // -- toString
149
150 // -------------------/
151 // - Private Methods -/
152 // -------------------/
153
154 /**
155 * Parses the given values and sets the appropriate flags for this FinalList.
156 *
157 * @param values the list of Final values.
158 **/
159 private void parseValues(String values) {
160
161 if (ALL.equals(values)) {
162 _all = true;
163 return;
164 }
165
166 StringTokenizer tokenizer = new StringTokenizer(values);
167
168 while (tokenizer.hasMoreTokens()) {
169 String value = tokenizer.nextToken();
170
171 if (EXTENSION.equals(value)) {
172 _extension = true;
173 } else if (RESTRICTION.equals(value)) {
174 _restriction = true;
175 } else {
176 String err = "invalid final list: " + values;
177 throw new IllegalArgumentException(err);
178 }
179 }
180
181 } // -- parseValues
182
183 } // -- class: FinalList