org.apache.commons.collections.primitives
Class ArrayBooleanList

java.lang.Object
  org.apache.commons.collections.primitives.AbstractBooleanCollection
      org.apache.commons.collections.primitives.RandomAccessBooleanList
          org.apache.commons.collections.primitives.ArrayBooleanList

All Implemented Interfaces:

Serializable, BooleanCollection, BooleanList

public class ArrayBooleanList
extends RandomAccessBooleanList
implements BooleanList, Serializable

An BooleanList backed by an array of booleans. This implementation supports all optional methods.

Since:

Commons Primitives 1.1

Version:

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.collections.primitives.RandomAccessBooleanList

RandomAccessBooleanList.RandomAccessBooleanListIterator, RandomAccessBooleanList.RandomAccessBooleanSubList

Constructor Summary

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

ArrayBooleanList(boolean[] array)
Constructs a list by copying the specified array.

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

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

Method Summary

void	add(int index, boolean element) Inserts the specified element at the specified position (optional operation).
boolean	addAll(BooleanCollection collection) Adds all of the elements in the specified collection to me (optional operation).
boolean	addAll(int index, BooleanCollection 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.
boolean	get(int index) Returns the value of the element at the specified position within me.
boolean	removeElementAt(int index) Removes the element at the specified position in (optional operation).
boolean	set(int index, boolean 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.RandomAccessBooleanList

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

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

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.BooleanList

add, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList

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

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

Constructor Detail

ArrayBooleanList

public ArrayBooleanList()

Construct an empty list with the default initial capacity.

ArrayBooleanList

public ArrayBooleanList(int initialCapacity)

Construct an empty list with the given initial capacity.

Throws:

IllegalArgumentException - when initialCapacity is negative

ArrayBooleanList

public ArrayBooleanList(BooleanCollection 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 booleans to add

Throws:

NullPointerException - if that is null

See Also:

addAll(BooleanCollection)

ArrayBooleanList

public ArrayBooleanList(boolean[] 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 boolean get(int index)

Description copied from interface: BooleanList

Returns the value of the element at the specified position within me.

Specified by:

get in interface BooleanList

Specified by:

get in class RandomAccessBooleanList

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: BooleanCollection

Returns the number of elements I contain.

Specified by:

size in interface BooleanCollection

Specified by:

size in class RandomAccessBooleanList

Returns:

the number of elements I contain

removeElementAt

public boolean 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 BooleanList

Overrides:

removeElementAt in class RandomAccessBooleanList

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 boolean set(int index,
                   boolean element)

Replaces the element at the specified position in me with the specified element (optional operation).

Specified by:

set in interface BooleanList

Overrides:

set in class RandomAccessBooleanList

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,
                boolean 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 BooleanList

Overrides:

add in class RandomAccessBooleanList

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: BooleanCollection

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

Specified by:

clear in interface BooleanCollection

Overrides:

clear in class AbstractBooleanCollection

addAll

public boolean addAll(BooleanCollection collection)

Description copied from interface: BooleanCollection

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

Specified by:

addAll in interface BooleanCollection

Overrides:

addAll in class AbstractBooleanCollection

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,
                      BooleanCollection collection)

Description copied from interface: BooleanList

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 BooleanList

Overrides:

addAll in class RandomAccessBooleanList

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.