org.apache.commons.collections.primitives
Class ArrayByteList

java.lang.Object
  extended by org.apache.commons.collections.primitives.AbstractByteCollection
      extended by org.apache.commons.collections.primitives.RandomAccessByteList
          extended by org.apache.commons.collections.primitives.ArrayByteList
All Implemented Interfaces:
java.io.Serializable, ByteCollection, ByteList

public class ArrayByteList
extends RandomAccessByteList
implements ByteList, java.io.Serializable

An ByteList backed by an array of bytes. This implementation supports all optional methods.

Since:
Commons Primitives 1.0
Version:
$Revision: 1.3 $ $Date: 2003/10/16 20:49:36 $
Author:
Rodney Waldhoff
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.commons.collections.primitives.RandomAccessByteList
RandomAccessByteList.RandomAccessByteListIterator, RandomAccessByteList.RandomAccessByteSubList
 
Field Summary
private  byte[] _data
           
private  int _size
           
 
Constructor Summary
ArrayByteList()
          Construct an empty list with the default initial capacity.
ArrayByteList(ByteCollection that)
          Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.
ArrayByteList(int initialCapacity)
          Construct an empty list with the given initial capacity.
 
Method Summary
 void add(int index, byte element)
          Inserts the specified element at the specified position (optional operation).
private  void checkRange(int index)
           
private  void checkRangeIncludingEndpoint(int index)
           
 void ensureCapacity(int mincap)
          Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.
 byte get(int index)
          Returns the value of the element at the specified position within me.
private  void readObject(java.io.ObjectInputStream in)
           
 byte removeElementAt(int index)
          Removes the element at the specified position in (optional operation).
 byte set(int index, byte element)
          Replaces the element at the specified position in me with the specified element (optional operation).
 int size()
          Returns the number of elements I contain.
 void trimToSize()
          Reduce my capacity, if necessary, to match my current size.
private  void writeObject(java.io.ObjectOutputStream out)
           
 
Methods inherited from class org.apache.commons.collections.primitives.RandomAccessByteList
add, addAll, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString
 
Methods inherited from class org.apache.commons.collections.primitives.AbstractByteCollection
addAll, clear, contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.collections.primitives.ByteList
add, addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList
 
Methods inherited from interface org.apache.commons.collections.primitives.ByteCollection
addAll, clear, contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 

Field Detail

_data

private transient byte[] _data

_size

private int _size
Constructor Detail

ArrayByteList

public ArrayByteList()
Construct an empty list with the default initial capacity.


ArrayByteList

public ArrayByteList(int initialCapacity)
Construct an empty list with the given initial capacity.

Throws:
java.lang.IllegalArgumentException - when initialCapacity is negative

ArrayByteList

public ArrayByteList(ByteCollection that)
Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.

Parameters:
that - the non-null collection of bytes to add
Throws:
java.lang.NullPointerException - if that is null
See Also:
AbstractByteCollection.addAll(org.apache.commons.collections.primitives.ByteCollection)
Method Detail

get

public byte get(int index)
Description copied from interface: ByteList
Returns the value of the element at the specified position within me.

Specified by:
get in interface ByteList
Specified by:
get in class RandomAccessByteList
Parameters:
index - the index of the element to return
Returns:
the value of the element at the specified position

size

public int size()
Description copied from interface: ByteCollection
Returns the number of elements I contain.

Specified by:
size in interface ByteCollection
Specified by:
size in class RandomAccessByteList
Returns:
the number of elements I contain

removeElementAt

public byte removeElementAt(int index)
Removes the element at the specified position in (optional operation). Any subsequent elements are shifted to the left, subtracting one from their indices. Returns the element that was removed.

Specified by:
removeElementAt in interface ByteList
Overrides:
removeElementAt in class RandomAccessByteList
Parameters:
index - the index of the element to remove
Returns:
the value of the element that was removed
Throws:
java.lang.UnsupportedOperationException - when this operation is not supported
java.lang.IndexOutOfBoundsException - if the specified index is out of range

set

public byte set(int index,
                byte element)
Replaces the element at the specified position in me with the specified element (optional operation).

Specified by:
set in interface ByteList
Overrides:
set in class RandomAccessByteList
Parameters:
index - the index of the element to change
element - the value to be stored at the specified position
Returns:
the value previously stored at the specified position
Throws:
java.lang.UnsupportedOperationException - when this operation is not supported
java.lang.IndexOutOfBoundsException - if the specified index is out of range

add

public void add(int index,
                byte element)
Inserts the specified element at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices.

Specified by:
add in interface ByteList
Overrides:
add in class RandomAccessByteList
Parameters:
index - the index at which to insert the element
element - the value to insert
Throws:
java.lang.UnsupportedOperationException - when this operation is not supported
java.lang.IllegalArgumentException - if some aspect of the specified element prevents it from being added to me
java.lang.IndexOutOfBoundsException - if the specified index is out of range

ensureCapacity

public void ensureCapacity(int mincap)
Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.


trimToSize

public void trimToSize()
Reduce my capacity, if necessary, to match my current size.


writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException
Throws:
java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException
Throws:
java.io.IOException
java.lang.ClassNotFoundException

checkRange

private final void checkRange(int index)

checkRangeIncludingEndpoint

private final void checkRangeIncludingEndpoint(int index)


Copyright (c) 2002-2003 - Apache Software Foundation