org.apache.commons.collections.primitives
Class ArrayByteList

java.lang.Object
  org.apache.commons.collections.primitives.AbstractByteCollection
      org.apache.commons.collections.primitives.RandomAccessByteList
          org.apache.commons.collections.primitives.ArrayByteList

All Implemented Interfaces:

Serializable, ByteCollection, ByteList

public class ArrayByteList
extends RandomAccessByteList
implements ByteList, Serializable

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

Since:

Commons Primitives 1.0

Version:

$Revision: 480460 $ $Date: 2006-11-29 09:14:21 +0100 (Wed, 29 Nov 2006) $

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

Constructor Summary

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

ArrayByteList(byte[] array)
Constructs a list by copying the specified array.

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).
boolean	addAll(ByteCollection collection) Adds all of the elements in the specified collection to me (optional operation).
boolean	addAll(int index, ByteCollection collection) Inserts all of the elements in the specified collection into me, at the specified position (optional operation).
void	clear() Removes all my elements (optional operation).
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.
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.

Methods inherited from class org.apache.commons.collections.primitives.RandomAccessByteList

add, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString

Methods inherited from class org.apache.commons.collections.primitives.AbstractByteCollection

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, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList

Methods inherited from interface org.apache.commons.collections.primitives.ByteCollection

contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray

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:

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:

NullPointerException - if that is null

See Also:

addAll(org.apache.commons.collections.primitives.ByteCollection)

ArrayByteList

public ArrayByteList(byte[] array)

Constructs a list by copying the specified array.

Parameters:

array - the array to initialize the collection with

Throws:

NullPointerException - if the array is null

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:

UnsupportedOperationException - when this operation is not supported

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:

UnsupportedOperationException - when this operation is not supported

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:

UnsupportedOperationException - when this operation is not supported

IllegalArgumentException - if some aspect of the specified element prevents it from being added to me

IndexOutOfBoundsException - if the specified index is out of range

clear

public void clear()

Description copied from interface: ByteCollection

Removes all my elements (optional operation). I will be empty after this method successfully returns.

Specified by:

clear in interface ByteCollection

Overrides:

clear in class AbstractByteCollection

addAll

public boolean addAll(ByteCollection collection)

Description copied from interface: ByteCollection

Adds all of the elements in the specified collection to me (optional operation).

Specified by:

addAll in interface ByteCollection

Overrides:

addAll in class AbstractByteCollection

Parameters:

collection - the collection of elements whose presence within me is to be ensured

Returns:

true iff I changed as a result of this call

addAll

public boolean addAll(int index,
                      ByteCollection collection)

Description copied from interface: ByteList

Inserts all of the elements in the specified collection into me, 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. The new elements will appear in the order that they are returned by the given collection's iterator.

Specified by:

addAll in interface ByteList

Overrides:

addAll in class RandomAccessByteList

Parameters:

index - the index at which to insert the first element from the specified collection

collection - the ByteCollection of elements to add

Returns:

true iff I changed as a result of this call

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.