← Back to branch summary

~vcs-imports/xena/trunk

« back to all changes in this revision

Viewing changes to ext/src/xerces-2_9_1/src/org/apache/xerces/xs/datatypes/ObjectList.java

  • Committer: matthewoliver
  • Date: 2009-12-10 03:18:07 UTC
  • Revision ID: vcs-imports@canonical.com-20091210031807-l086qguzdlljtkl9
Merged Xena Testing into Xena Stable for the Xena 5 release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ext/src/xerces-2_9_1/src/org/apache/xerces/xs/datatypes/ObjectList.java
 
1
/*
 
2
 * Licensed to the Apache Software Foundation (ASF) under one or more
 
3
 * contributor license agreements.  See the NOTICE file distributed with
 
4
 * this work for additional information regarding copyright ownership.
 
5
 * The ASF licenses this file to You under the Apache License, Version 2.0
 
6
 * (the "License"); you may not use this file except in compliance with
 
7
 * the License.  You may obtain a copy of the License at
 
8
 * 
 
9
 *      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
package org.apache.xerces.xs.datatypes;
 
18
 
 
19
/**
 
20
 * <p>The <code>ObjectList</code> is an immutable ordered collection of 
 
21
 * <code>Object</code>.</p> 
 
22
 * 
 
23
 * @author Ankit Pasricha, IBM
 
24
 * 
 
25
 * @version $Id: ObjectList.java,v 1.2 2009/12/10 03:18:45 matthewoliver Exp $
 
26
 */
 
27
public interface ObjectList {
 
28
    
 
29
    /**
 
30
     * The number of <code>Object</code>s in the list. The range of 
 
31
     * valid child object indices is 0 to <code>length-1</code> inclusive. 
 
32
     */
 
33
    public int getLength();
 
34
    
 
35
    /**
 
36
     * Checks if the <code>Object</code> <code>item</code> is a 
 
37
     * member of this list. 
 
38
     * @param item  <code>Object</code> whose presence in this list 
 
39
     *   is to be tested. 
 
40
     * @return  True if this list contains the <code>Object</code> 
 
41
     *   <code>item</code>. 
 
42
     */
 
43
    public boolean contains(Object item);
 
44
    
 
45
    /**
 
46
     * Returns the <code>index</code>th item in the collection or 
 
47
     * <code>null</code> if <code>index</code> is greater than or equal to 
 
48
     * the number of objects in the list. The index starts at 0. 
 
49
     * @param index  index into the collection. 
 
50
     * @return  The <code>Object</code> at the <code>index</code>th 
 
51
     *   position in the <code>ObjectList</code>, or <code>null</code> if 
 
52
     *   the index specified is not valid - greater than or equal to the
 
53
     *   number of items in the list or less than zero. 
 
54
     */
 
55
    public Object item(int index);
 
56
    
 
57
}