org.apache.commons.collections.primitives
Class RandomAccessBooleanList

java.lang.Object
  extended by org.apache.commons.collections.primitives.AbstractBooleanCollection
      extended by org.apache.commons.collections.primitives.RandomAccessBooleanList
All Implemented Interfaces:
BooleanCollection, BooleanList
Direct Known Subclasses:
ArrayBooleanList, RandomAccessBooleanList.RandomAccessBooleanSubList

public abstract class RandomAccessBooleanList
extends AbstractBooleanCollection
implements BooleanList

Abstract base class for BooleanLists backed by random access structures like arrays.

Read-only subclasses must override get(int) and size(). Mutable subclasses should also override set(int, boolean). Variably-sized subclasses should also override add(boolean) and removeElementAt(int). All other methods have at least some base implementation derived from these. Subclasses may choose to override these methods to provide a more efficient implementation.

Since:
Commons Primitives 1.2
Version:
$Revision: 480460 $

Nested Class Summary
protected static class RandomAccessBooleanList.RandomAccessBooleanListIterator
           
protected static class RandomAccessBooleanList.RandomAccessBooleanSubList
           
 
Constructor Summary
protected RandomAccessBooleanList()
          Constructs an empty list.
 
Method Summary
 boolean add(boolean element)
          Unsupported in this base implementation.
 void add(int index, boolean element)
          Unsupported in this implementation.
 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(java.lang.Object that)
          Returns true iff that is an BooleanList that contains the same elements in the same order as me.
abstract  boolean get(int index)
          Returns the value of the element at the specified position within me.
protected  int getModCount()
          Get my count of structural modifications.
 int hashCode()
           
protected  void incrModCount()
          Increment my count of structural modifications.
 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.
 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)
          Unsupported in this implementation.
 boolean set(int index, boolean element)
          Unsupported in this implementation.
abstract  int size()
          Returns the number of elements I contain.
 BooleanList subList(int fromIndex, int toIndex)
          Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive.
 java.lang.String toString()
           
 
Methods inherited from class org.apache.commons.collections.primitives.AbstractBooleanCollection
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.BooleanCollection
addAll, clear, contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray
 

Constructor Detail

RandomAccessBooleanList

protected RandomAccessBooleanList()
Constructs an empty list.

Method Detail

get

public abstract 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
Parameters:
index - the index of the element to return
Returns:
the value of the element at the specified position

size

public abstract 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 AbstractBooleanCollection
Returns:
the number of elements I contain

removeElementAt

public boolean removeElementAt(int index)
Unsupported in this implementation.

Specified by:
removeElementAt in interface BooleanList
Parameters:
index - the index of the element to remove
Returns:
the value of the element that was removed
Throws:
java.lang.UnsupportedOperationException - since this method is not supported

set

public boolean set(int index,
                   boolean element)
Unsupported in this implementation.

Specified by:
set in interface BooleanList
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 - since this method is not supported

add

public void add(int index,
                boolean element)
Unsupported in this implementation.

Specified by:
add in interface BooleanList
Parameters:
index - the index at which to insert the element
element - the value to insert
Throws:
java.lang.UnsupportedOperationException - since this method is not supported

add

public boolean add(boolean element)
Description copied from class: AbstractBooleanCollection
Unsupported in this base implementation.

Specified by:
add in interface BooleanCollection
Specified by:
add in interface BooleanList
Overrides:
add in class AbstractBooleanCollection
Parameters:
element - the value 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
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

indexOf

public int indexOf(boolean element)
Description copied from interface: BooleanList
Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain the element.

Specified by:
indexOf in interface BooleanList
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

lastIndexOf

public int lastIndexOf(boolean element)
Description copied from interface: BooleanList
Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.

Specified by:
lastIndexOf in interface BooleanList
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

iterator

public BooleanIterator iterator()
Description copied from interface: BooleanCollection
Returns an iterator over all my elements. This base interface places no constraints on the order in which the elements are returned by the returned iterator.

Specified by:
iterator in interface BooleanCollection
Specified by:
iterator in interface BooleanList
Specified by:
iterator in class AbstractBooleanCollection
Returns:
an iterator over all my elements.

listIterator

public BooleanListIterator listIterator()
Description copied from interface: BooleanList
Returns a bidirectional iterator over all my elements, in the appropriate sequence.

Specified by:
listIterator in interface BooleanList

listIterator

public BooleanListIterator listIterator(int index)
Description copied from interface: BooleanList
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.

Specified by:
listIterator in interface BooleanList

subList

public BooleanList subList(int fromIndex,
                           int toIndex)
Description copied from interface: BooleanList
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.

Specified by:
subList in interface BooleanList
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)

equals

public boolean equals(java.lang.Object that)
Description copied from interface: BooleanList
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.)

Specified by:
equals in interface BooleanList
Overrides:
equals in class java.lang.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

hashCode

public int hashCode()
Specified by:
hashCode in interface BooleanList
Overrides:
hashCode in class java.lang.Object
Returns:
my hash code

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getModCount

protected int getModCount()
Get my count of structural modifications.


incrModCount

protected void incrModCount()
Increment my count of structural modifications.



Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.