01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: package org.apache.xerces.xs;
19:
20: /**
21: * The <code>StringList</code> is an immutable ordered collection of
22: * <code>GenericString</code>.
23: */
24: public interface StringList {
25: /**
26: * The number of <code>GenericString</code>s in the list. The range of
27: * valid child object indices is 0 to <code>length-1</code> inclusive.
28: */
29: public int getLength();
30:
31: /**
32: * Checks if the <code>GenericString</code> <code>item</code> is a member
33: * of this list.
34: * @param item <code>GenericString</code> whose presence in this list is
35: * to be tested.
36: * @return True if this list contains the <code>GenericString</code>
37: * <code>item</code>.
38: */
39: public boolean contains(String item);
40:
41: /**
42: * Returns the <code>index</code>th item in the collection or
43: * <code>null</code> if <code>index</code> is greater than or equal to
44: * the number of objects in the list. The index starts at 0.
45: * @param index index into the collection.
46: * @return The <code>GenericString</code> at the <code>index</code>th
47: * position in the <code>StringList</code>, or <code>null</code> if
48: * the index specified is not valid.
49: */
50: public String item(int index);
51:
52: }
|