it.unimi.dsi.fastutil.booleans
Class AbstractBooleanList

java.lang.Object
  extended byit.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
      extended byit.unimi.dsi.fastutil.booleans.AbstractBooleanList
All Implemented Interfaces:
BooleanCollection, BooleanList, BooleanStack, Collection, Comparable, List, Stack
Direct Known Subclasses:
AbstractBooleanList.BooleanSubList, BooleanArrayList, BooleanLists.Singleton

public abstract class AbstractBooleanList
extends AbstractBooleanCollection
implements BooleanList, BooleanStack

An abstract class providing basic methods for lists implementing a type-specific list interface.

As an additional bonus, this class implements on top of the list operations a type-specific stack.


Nested Class Summary
static class AbstractBooleanList.BooleanSubList
           
 
Method Summary
 boolean add(boolean k)
           
 void add(int index, boolean k)
           
 void add(int index, Object ok)
          Delegates to the corresponding type-specific method.
 boolean addAll(BooleanCollection c)
          Delegates to a more generic method.
 boolean addAll(BooleanList l)
          Delegates to a more generic method.
 boolean addAll(Collection c)
          Delegates to a more generic method.
 boolean addAll(int index, BooleanCollection c)
          Delegates to a more generic method.
 boolean addAll(int index, BooleanList l)
          Delegates to a more generic method.
 boolean addAll(int index, Collection c)
           
 void addElements(int index, boolean[] a)
          Add (hopefully quickly) elements to this type-specific list.
 void addElements(int index, boolean[] a, int offset, int length)
          Adds elements to this type-specific list one-by-one.
 BooleanIterator booleanIterator()
          Delegates to the corresponding list-iterator method.
 BooleanListIterator booleanListIterator()
          Delegates to the corresponding list-iterator method.
 BooleanListIterator booleanListIterator(int index)
          Returns a type-specific list iterator on the list starting at a given index.
 BooleanList booleanSubList(int from, int to)
           
 int compareTo(Object o)
          Compares this list to another object.
 boolean contains(boolean k)
           
 boolean equals(Object o)
           
 Object get(int index)
          Delegates to the corresponding type-specific method.
 void getElements(int from, boolean[] a, int offset, int length)
          Copies element of this type-specific list into the given array one-by-one.
 int hashCode()
          Returns the hash code for this list, which is identical to List.hashCode().
 int indexOf(boolean k)
           
 int indexOf(Object ok)
          Delegates to the corresponding type-specific method.
 int lastIndexOf(boolean k)
           
 int lastIndexOf(Object ok)
          Delegates to the corresponding type-specific method.
 ListIterator listIterator()
          Delegates to the corresponding type-specific method.
 ListIterator listIterator(int index)
          Delegates to the corresponding type-specific method.
 Object peek(int i)
          Delegates to the corresponding type-specific method.
 boolean peekBoolean(int i)
           
 Object pop()
          Delegates to the corresponding type-specific method.
 boolean popBoolean()
           
 void push(boolean o)
           
 void push(Object o)
          Delegates to the corresponding type-specific method.
 boolean rem(boolean k)
          Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name.
 Object remove(int index)
          Delegates to the corresponding type-specific method.
 boolean removeBoolean(int i)
           
 void removeElements(int from, int to)
          Removes elements of this type-specific list one-by-one.
 boolean set(int index, boolean k)
           
 Object set(int index, Object ok)
          Delegates to the corresponding type-specific method.
 void size(int size)
          Sets the size of this list.
 List subList(int from, int to)
          Delegates to the corresponding type-specific method.
 Object top()
          Delegates to the corresponding type-specific method.
 boolean topBoolean()
           
 String toString()
           
 
Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
add, clear, contains, containsAll, containsAll, isEmpty, iterator, rem, remove, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toBooleanArray, toBooleanArray
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanList
getBoolean
 
Methods inherited from interface java.util.List
add, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
 
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection
containsAll, removeAll, retainAll, toArray, toBooleanArray, toBooleanArray
 
Methods inherited from interface it.unimi.dsi.fastutil.Stack
isEmpty
 

Method Detail

add

public void add(int index,
                boolean k)
Specified by:
add in interface BooleanList
See Also:
List.add(int,Object)

add

public boolean add(boolean k)
Specified by:
add in interface BooleanCollection
Overrides:
add in class AbstractBooleanCollection

rem

public boolean rem(boolean k)
Description copied from interface: BooleanCollection
Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name. For simplicity, the set interfaces reinstates remove().

Specified by:
rem in interface BooleanCollection
Overrides:
rem in class AbstractBooleanCollection

removeBoolean

public boolean removeBoolean(int i)
Specified by:
removeBoolean in interface BooleanList
See Also:
List.remove(int)

set

public boolean set(int index,
                   boolean k)
Specified by:
set in interface BooleanList
See Also:
List.set(int,Object)

addAll

public boolean addAll(int index,
                      Collection c)
Specified by:
addAll in interface List

addAll

public boolean addAll(int index,
                      BooleanCollection c)
Delegates to a more generic method.

Specified by:
addAll in interface BooleanList
See Also:
List.add(int,Object)

addAll

public boolean addAll(int index,
                      BooleanList l)
Delegates to a more generic method.

Specified by:
addAll in interface BooleanList
See Also:
List.add(int,Object)

addAll

public boolean addAll(Collection c)
Delegates to a more generic method.

Specified by:
addAll in interface List
Overrides:
addAll in class AbstractBooleanCollection
Parameters:
c - a collection.
Returns:
true if this collection changed as a result of the call.

addAll

public boolean addAll(BooleanCollection c)
Delegates to a more generic method.

Specified by:
addAll in interface BooleanCollection
Overrides:
addAll in class AbstractBooleanCollection
Parameters:
c - a type-specific collection.
Returns:
true if this collection changed as a result of the call.

addAll

public boolean addAll(BooleanList l)
Delegates to a more generic method.

Specified by:
addAll in interface BooleanList
See Also:
List.add(int,Object)

listIterator

public ListIterator listIterator()
Delegates to the corresponding type-specific method.

Specified by:
listIterator in interface List

listIterator

public ListIterator listIterator(int index)
Delegates to the corresponding type-specific method.

Specified by:
listIterator in interface List

booleanIterator

public BooleanIterator booleanIterator()
Delegates to the corresponding list-iterator method.

Specified by:
booleanIterator in interface BooleanCollection
See Also:
Collection.iterator()

booleanListIterator

public BooleanListIterator booleanListIterator()
Delegates to the corresponding list-iterator method.

Specified by:
booleanListIterator in interface BooleanList
See Also:
List.listIterator()

booleanListIterator

public BooleanListIterator booleanListIterator(int index)
Description copied from interface: BooleanList
Returns a type-specific list iterator on the list starting at a given index.

The iterator returned by the List.listIterator() method and by this method are identical; however, using this method you can save a type casting.

Specified by:
booleanListIterator in interface BooleanList
See Also:
List.listIterator(int)

contains

public boolean contains(boolean k)
Specified by:
contains in interface BooleanCollection
See Also:
Collection.contains(Object)

indexOf

public int indexOf(boolean k)
Specified by:
indexOf in interface BooleanList
See Also:
List.indexOf(Object)

lastIndexOf

public int lastIndexOf(boolean k)
Specified by:
lastIndexOf in interface BooleanList
See Also:
List.lastIndexOf(Object)

size

public void size(int size)
Description copied from interface: BooleanList
Sets the size of this list.

If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/null/false.

Specified by:
size in interface BooleanList
Parameters:
size - the new size.

booleanSubList

public BooleanList booleanSubList(int from,
                                  int to)
Specified by:
booleanSubList in interface BooleanList
See Also:
List.subList(int,int)

subList

public List subList(int from,
                    int to)
Delegates to the corresponding type-specific method.

Specified by:
subList in interface List

removeElements

public void removeElements(int from,
                           int to)
Removes elements of this type-specific list one-by-one.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:
removeElements in interface BooleanList
Parameters:
from - the start index (inclusive).
to - the end index (exclusive).

addElements

public void addElements(int index,
                        boolean[] a,
                        int offset,
                        int length)
Adds elements to this type-specific list one-by-one.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:
addElements in interface BooleanList
Parameters:
index - the index at which to add elements.
a - the array containing the elements.
offset - the offset of the first element to add.
length - the number of elements to add.

addElements

public void addElements(int index,
                        boolean[] a)
Description copied from interface: BooleanList
Add (hopefully quickly) elements to this type-specific list.

Specified by:
addElements in interface BooleanList
Parameters:
index - the index at which to add elements.
a - the array containing the elements.

getElements

public void getElements(int from,
                        boolean[] a,
                        int offset,
                        int length)
Copies element of this type-specific list into the given array one-by-one.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:
getElements in interface BooleanList
Parameters:
from - the start index (inclusive).
a - the destination array.
offset - the offset into the destination array where to store the first element copied.
length - the number of elements to be copied.

equals

public boolean equals(Object o)
Specified by:
equals in interface List

compareTo

public int compareTo(Object o)
Compares this list to another object. If the argument is a List, this method performs a lexicographical comparison; otherwise, it throws a ClassCastException.

Specified by:
compareTo in interface Comparable
Parameters:
o - an object.
Returns:
if the argument is a List, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
Throws:
ClassCastException - if the argument is not a list.

hashCode

public int hashCode()
Returns the hash code for this list, which is identical to List.hashCode().

Specified by:
hashCode in interface List
Returns:
the hash code for this list.

push

public void push(boolean o)
Specified by:
push in interface BooleanStack
See Also:
Stack.push(Object)

popBoolean

public boolean popBoolean()
Specified by:
popBoolean in interface BooleanStack
See Also:
Stack.pop()

topBoolean

public boolean topBoolean()
Specified by:
topBoolean in interface BooleanStack
See Also:
Stack.top()

peekBoolean

public boolean peekBoolean(int i)
Specified by:
peekBoolean in interface BooleanStack
See Also:
Stack.peek(int)

add

public void add(int index,
                Object ok)
Delegates to the corresponding type-specific method.

Specified by:
add in interface List

set

public Object set(int index,
                  Object ok)
Delegates to the corresponding type-specific method.

Specified by:
set in interface List

get

public Object get(int index)
Delegates to the corresponding type-specific method.

Specified by:
get in interface List

indexOf

public int indexOf(Object ok)
Delegates to the corresponding type-specific method.

Specified by:
indexOf in interface List

lastIndexOf

public int lastIndexOf(Object ok)
Delegates to the corresponding type-specific method.

Specified by:
lastIndexOf in interface List

remove

public Object remove(int index)
Delegates to the corresponding type-specific method.

Specified by:
remove in interface List

push

public void push(Object o)
Delegates to the corresponding type-specific method.

Specified by:
push in interface Stack
Parameters:
o - the object that will become the new top of the stack.

pop

public Object pop()
Delegates to the corresponding type-specific method.

Specified by:
pop in interface Stack
Returns:
the top of the stack.

top

public Object top()
Delegates to the corresponding type-specific method.

Specified by:
top in interface Stack
Returns:
the top of the stack.

peek

public Object peek(int i)
Delegates to the corresponding type-specific method.

Specified by:
peek in interface Stack
Returns:
the i-th element on the stack; 0 represents the top.

toString

public String toString()
Overrides:
toString in class AbstractBooleanCollection