org.apache.commons.collections.primitives
Interface BooleanList

All Superinterfaces:

BooleanCollection

All Known Implementing Classes:

ArrayBooleanList, ListBooleanList, RandomAccessBooleanList, RandomAccessBooleanList.RandomAccessBooleanSubList

public interface BooleanList
extends BooleanCollection

An ordered collection of byte values.

Since:

Commons Primitives 1.1

Version:

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

See Also:

BooleanListList, org.apache.commons.collections.primitives.adapters.BooleanByteList

Method Summary

boolean	add(boolean element) Appends the specified element to the end of me (optional operation).
void	add(int index, boolean element) Inserts the specified element at the specified position (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).
boolean	equals(Object that) Returns true iff that is an BooleanList that contains the same elements in the same order as me.
boolean	get(int index) Returns the value of the element at the specified position within me.
int	hashCode()
int	indexOf(boolean element) Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain the element.
BooleanIterator	iterator() Returns an iterator over all my elements, in the appropriate sequence.
int	lastIndexOf(boolean element) Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.
BooleanListIterator	listIterator() Returns a bidirectional iterator over all my elements, in the appropriate sequence.
BooleanListIterator	listIterator(int index) Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position.
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).
BooleanList	subList(int fromIndex, int toIndex) Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive.

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

addAll, clear, contains, containsAll, isEmpty, removeAll, removeElement, retainAll, size, toArray, toArray

Method Detail

add

boolean add(boolean element)

Appends the specified element to the end of me (optional operation). Returns true iff I changed as a result of this call.

If a collection refuses to add the specified element for any reason other than that it already contains the element, it must throw an exception (rather than simply returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface BooleanCollection

Parameters:

element - the value whose presence within me is to be ensured

Returns:

true iff I changed as a result of this call

Throws:

UnsupportedOperationException - when this operation is not supported

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

add

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.

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

addAll

boolean addAll(int index,
               BooleanCollection collection)

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.

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

Throws:

UnsupportedOperationException - when this operation is not supported

IndexOutOfBoundsException - if the specified index is out of range

equals

boolean equals(Object that)

Returns true iff that is an BooleanList that contains the same elements in the same order as me. In other words, returns true iff that is a BooleanList that has the same size as me, and for which the elements returned by its iterator are equal (==) to the corresponding elements within me. (This contract ensures that this method works properly across different implementations of the BooleanList interface.)

Overrides:

equals in class Object

Parameters:

that - the object to compare to me

Returns:

true iff that is an BooleanList that contains the same elements in the same order as me

get

boolean get(int index)

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

Parameters:

index - the index of the element to return

Returns:

the value of the element at the specified position

Throws:

IndexOutOfBoundsException - if the specified index is out of range

hashCode

int hashCode()

Overrides:

hashCode in class Object

Returns:

my hash code

indexOf

int indexOf(boolean element)

Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain the element.

Parameters:

element - the element to search for

Returns:

the smallest index of an element matching the specified value, or -1 if no such matching element can be found

iterator

BooleanIterator iterator()

Returns an iterator over all my elements, in the appropriate sequence.

Specified by:

iterator in interface BooleanCollection

Returns:

an iterator over all my elements.

lastIndexOf

int lastIndexOf(boolean element)

Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.

Parameters:

element - the element to search for

Returns:

the largest index of an element matching the specified value, or -1 if no such matching element can be found

listIterator

BooleanListIterator listIterator()

Returns a bidirectional iterator over all my elements, in the appropriate sequence.

listIterator

BooleanListIterator listIterator(int index)

Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

Throws:

IndexOutOfBoundsException - if the specified index is out of range

removeElementAt

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.

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

boolean set(int index,
            boolean element)

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

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

subList

BooleanList subList(int fromIndex,
                    int toIndex)

Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive. The returned BooleanList is backed by me, so that any changes in the returned list are reflected in me, and vice-versa. The returned list supports all of the optional operations that I support.

Note that when fromIndex == toIndex, the returned list is initially empty, and when fromIndex == 0 && toIndex == size() the returned list is my "improper" sublist, containing all my elements.

The semantics of the returned list become undefined if I am structurally modified in any way other than via the returned list.

Parameters:

fromIndex - the smallest index (inclusive) in me that appears in the returned list

toIndex - the largest index (exclusive) in me that appears in the returned list

Returns:

a view of this list from fromIndex (inclusive) to toIndex (exclusive)

Throws:

IndexOutOfBoundsException - if either specified index is out of range