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 2001 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35
36 package org.exolab.castor.xml.schema;
37
38 /**
39 * Represents an enumerated type which consists of two values: "qualified" and "unqualified". This
40 * is used for the "form" property on attribute and element defintions as well as the
41 * attributeFormDefault and elementFormDefault proprties on the Schema itself.
42 *
43 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
44 * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
45 **/
46 public class Form {
47
48 /**
49 * The String value for the qualified Form
50 **/
51 public static final String QUALIFIED_VALUE = "qualified";
52
53 /**
54 * The String value for the unqualified Form
55 **/
56 public static final String UNQUALIFIED_VALUE = "unqualified";
57
58
59 /**
60 * The Qualified Form Object
61 **/
62 public static final Form Qualified = new Form(QUALIFIED_VALUE);
63
64 /**
65 * The Qualified Form Object
66 **/
67 public static final Form Unqualified = new Form(UNQUALIFIED_VALUE);
68
69 /**
70 * The value of this Form
71 **/
72 private String _value = UNQUALIFIED_VALUE;
73
74 /**
75 * Creates a new Form
76 *
77 * @param value the value of the Form
78 **/
79 private Form(String value) {
80 _value = value;
81 } // -- Form
82
83 /**
84 * Returns the String value of this Form.
85 *
86 * @return the String value of this Form.
87 **/
88 public String getValue() {
89 return _value;
90 } // -- getValue
91
92 /**
93 * Returns true if this Form is the qualified Form.
94 *
95 * @return true if this Form is the qualified Form.
96 **/
97 public boolean isQualified() {
98 return (this == Qualified);
99 } // -- isQualified
100
101 /**
102 * Returns true if this Form is the unqualified Form.
103 *
104 * @return true if this Form is the unqualified Form.
105 **/
106 public boolean isUnqualified() {
107 return (this == Unqualified);
108 } // -- isUnqualified
109
110 /**
111 * Returns the String value of this Form.
112 *
113 * @return the String value of this Form.
114 **/
115 public String toString() {
116 return _value;
117 } // -- toString
118
119 /**
120 * Returns the Form corresponding to the given value.
121 *
122 * @param formValue the value of the Form to return.
123 * @return the Form corresponding to the given value.
124 * @exception IllegalArgumentException when the given value is not valid.
125 **/
126 public static Form valueOf(String formValue) {
127 if (QUALIFIED_VALUE.equals(formValue)) {
128 return Form.Qualified;
129 } else if (UNQUALIFIED_VALUE.equals(formValue)) {
130 return Form.Unqualified;
131 } else {
132 String err = formValue + " is not a valid Form value.";
133 throw new IllegalArgumentException(err);
134 }
135 } // -- valueOf
136
137 } // -- Form