View Javadoc
1   /*
2    * reserved comment block
3    * DO NOT REMOVE OR ALTER!
4    */
5   /*
6    * Copyright 2003,2004 The Apache Software Foundation.
7    *
8    * Licensed under the Apache License, Version 2.0 (the "License");
9    * you may not use this file except in compliance with the License.
10   * You may obtain a copy of the License at
11   *
12   *      http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS,
16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   * See the License for the specific language governing permissions and
18   * limitations under the License.
19   */
20  
21  package com.sun.org.apache.xerces.internal.xs;
22  
23  import java.util.List;
24  
25  /**
26   *  The <code>StringList</code> is an immutable ordered collection of
27   * <code>GenericString</code>.
28   */
29  public interface StringList extends List {
30      /**
31       *  The number of <code>GenericString</code>s in the list. The range of
32       * valid child object indices is 0 to <code>length-1</code> inclusive.
33       */
34      public int getLength();
35  
36      /**
37       *  Checks if the <code>GenericString</code> <code>item</code> is a member
38       * of this list.
39       * @param item  <code>GenericString</code> whose presence in this list is
40       *   to be tested.
41       * @return  True if this list contains the <code>GenericString</code>
42       *   <code>item</code>.
43       */
44      public boolean contains(String item);
45  
46      /**
47       *  Returns the <code>index</code>th item in the collection or
48       * <code>null</code> if <code>index</code> is greater than or equal to
49       * the number of objects in the list. The index starts at 0.
50       * @param index  index into the collection.
51       * @return  The <code>GenericString</code> at the <code>index</code>th
52       *   position in the <code>StringList</code>, or <code>null</code> if
53       *   the index specified is not valid.
54       */
55      public String item(int index);
56  
57  }