/*
 * 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.datatypes;

import java.util.List;

import org.apache.xerces.xs.XSException;

The ByteList is an immutable ordered collection of byte.

Author:Ankit Pasricha, IBM
Version:$Id: ByteList.java 1024038 2010-10-18 22:06:35Z sandygao $
/** * <p>The <code>ByteList</code> is an immutable ordered collection of * <code>byte</code>.</p> * * @author Ankit Pasricha, IBM * * @version $Id: ByteList.java 1024038 2010-10-18 22:06:35Z sandygao $ */
public interface ByteList extends List {
The number of bytes in the list. The range of valid child object indices is 0 to length-1 inclusive.
/** * The number of <code>byte</code>s in the list. The range of * valid child object indices is 0 to <code>length-1</code> inclusive. */
public int getLength();
Checks if the byte item is a member of this list.
Params:
  • item – byte whose presence in this list is to be tested.
Returns: True if this list contains the byte item.
/** * Checks if the <code>byte</code> <code>item</code> is a * member of this list. * @param item <code>byte</code> whose presence in this list * is to be tested. * @return True if this list contains the <code>byte</code> * <code>item</code>. */
public boolean contains(byte item);
Returns the indexth item in the collection. The index starts at 0.
Params:
  • index – index into the collection.
Throws:
  • XSException – INDEX_SIZE_ERR: if index is greater than or equal to the number of objects in the list or less than zero.
Returns: The byte at the indexth position in the ByteList.
/** * Returns the <code>index</code>th item in the collection. The index * starts at 0. * @param index index into the collection. * @return The <code>byte</code> at the <code>index</code>th * position in the <code>ByteList</code>. * @exception XSException * INDEX_SIZE_ERR: if <code>index</code> is greater than or equal to the * number of objects in the list or less than zero. */
public byte item(int index) throws XSException;
Construct and return a byte array for bytes contained in this list.
/** * Construct and return a byte array for bytes contained in this list. */
public byte[] toByteArray(); }