1 /**
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id$
44 */
45 package org.exolab.castor.xml.schema;
46
47 import java.util.ArrayList;
48 import java.util.Enumeration;
49 import java.util.List;
50
51
52 /**
53 * A list for maintaining facets
54 *
55 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
56 * @version $Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
57 **/
58 public class FacetList implements java.io.Serializable {
59 /** SerialVersionUID */
60 private static final long serialVersionUID = 3855871093270831240L;
61
62 /**
63 * The list of facets
64 **/
65 private List<Facet> facets = null;
66
67 /**
68 * Creates a new FacetList
69 **/
70 public FacetList() {
71 facets = new ArrayList<Facet>();
72 } //-- FacetList
73
74 /**
75 * Adds the given Facet to this list
76 * @param facet the facet to add
77 **/
78 public void add(Facet facet) {
79 if (facet != null) {
80 facets.add(facet);
81 }
82 } //-- add
83
84 /**
85 * Adds the facets from the given list into this FacetList
86 *
87 * @param facetList the FacetList to copy from
88 */
89 public void add(FacetList facetList) {
90 if (facetList == null) {
91 return;
92 }
93 for (int i = 0; i < facetList.facets.size(); i++) {
94 facets.add(facetList.facets.get(i));
95 }
96 } //-- add
97
98
99 /**
100 * Returns the facet at the given index
101 * @param index the index of the Facet to return
102 **/
103 public Facet get(int index) {
104 return facets.get(index);
105 } //-- get
106
107 /**
108 * Removes the given Facet from this list
109 * @param facet the Facet to remove
110 **/
111 public boolean remove(Facet facet) {
112 return facets.remove(facet);
113 } //-- remove
114
115 /**
116 * Removes the facet located at the given index
117 *
118 * @param index the index of the Facet to remove
119 * @return the removed facet
120 */
121 public Facet remove(int index) {
122 return facets.remove(index);
123 } //-- remove
124
125
126 /**
127 * Returns the number of Facets in this list
128 * @return the number of Facets in this list
129 **/
130 public int size() {
131 return facets.size();
132 } //-- size
133
134 /**
135 * Returns an Enumeration of the Facets in this list
136 * @return an Enumeration of the Facets in this list
137 **/
138 public Enumeration<Facet> enumerate() {
139 return new FacetListEnumerator(this);
140 } //-- enumerate
141
142 /**
143 * Returns the facet of the list with with the given name.
144 * In case of an ENUMERATION the first facet is returned.
145 * If none of the name of the facets of that list
146 * correspond to the given name, null is returned.
147 *
148 * @param name the facet name to look for.
149 *
150 * @return The facet of the list with the given name
151 */
152 public Facet contains(String name) {
153 if (name == null) {
154 return null;
155 }
156 Enumeration<Facet> enumeration = enumerate();
157 while (enumeration.hasMoreElements()) {
158 Facet temp = enumeration.nextElement();
159 if (temp.getName().equals(name))
160 return temp;
161 }
162 return null;
163 }
164
165 } //-- FacetList
166