org.apache.xerces.xs.ShortList Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xercesImpl Show documentation

A slightly adapted version of Xerces 2.11.0 to allow the XMLStringBuffer responsible for XML attribute scanning to start larger and thus avoid extended appending times. The initial buffer size is controlled by settting the system property julielab.xerces.attributebuffersize (also available as constant XMLScanner#ATTRIBUTE_BUFFER_SIZE).

There is a newer version: 2.11.0.1

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.xerces.xs;

import java.util.List;

/**
 *  The ShortList is an immutable ordered collection of 
 * unsigned short. 
 */
public interface ShortList extends List {
    /**
     *  The number of unsigned shorts in the list. The range of 
     * valid child object indices is 0 to length-1 inclusive. 
     */
    public int getLength();

    /**
     *  Checks if the unsigned short item is a 
     * member of this list. 
     * @param item  unsigned short whose presence in this list 
     *   is to be tested. 
     * @return  True if this list contains the unsigned short 
     *   item. 
     */
    public boolean contains(short item);

    /**
     *  Returns the indexth item in the collection. The index 
     * starts at 0. 
     * @param index  index into the collection. 
     * @return  The unsigned short at the indexth 
     *   position in the ShortList. 
     * @exception XSException
     *   INDEX_SIZE_ERR: if index is greater than or equal to the 
     *   number of objects in the list.
     */
    public short item(int index)
                      throws XSException;

}