ByteList (Smooks 2.0.0-RC4 API)

All Superinterfaces:

Collection, Iterable, List

All Known Implementing Classes:

ByteListImpl
```
public interface ByteList
extends List
```
The ByteList is an immutable ordered collection of byte.

Version:

$Id$

Author:

Ankit Pasricha, IBM

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`contains(byte item)`	Checks if the `byte` `item` is a member of this list.
`int`	`getLength()`	The number of `byte`s in the list.
`byte`	`item(int index)`	Returns the `index`th item in the collection.
`byte[]`	`toByteArray()`	Construct and return a byte array for bytes contained in this list.

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

- Method Detail
  - getLength
```
int getLength()
```
    The number of bytes in the list. The range of valid child object indices is 0 to length-1 inclusive.
  - contains
```
boolean contains(byte item)
```
    Checks if the byte item is a member of this list.
    
    Parameters:
    
    item - byte whose presence in this list is to be tested.
    
    Returns:
    
    True if this list contains the byte item.
  - item
```
byte item(int index)
   throws XSException
```
    Returns the indexth item in the collection. The index starts at 0.
    
    Parameters:
    
    index - index into the collection.
    
    Returns:
    
    The byte at the indexth position in the ByteList.
    
    Throws:
    
    XSException - INDEX_SIZE_ERR: if index is greater than or equal to the number of objects in the list or less than zero.
  - toByteArray
```
byte[] toByteArray()
```
    Construct and return a byte array for bytes contained in this list.