it.unimi.dsi.fastutil.booleans
Class AbstractBooleanList

java.lang.Object
  extended by it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
      extended by it.unimi.dsi.fastutil.booleans.AbstractBooleanList
All Implemented Interfaces:
BooleanCollection, BooleanIterable, BooleanList, BooleanStack, Stack<java.lang.Boolean>, java.lang.Comparable<java.util.List<? extends java.lang.Boolean>>, java.lang.Iterable<java.lang.Boolean>, java.util.Collection<java.lang.Boolean>, java.util.List<java.lang.Boolean>
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, java.lang.Boolean ok)
          Delegates to the corresponding type-specific method.
 boolean addAll(BooleanCollection c)
          Adds all elements of the given type-specific collection to this collection.
 boolean addAll(BooleanList l)
           
 boolean addAll(java.util.Collection<? extends java.lang.Boolean> 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, java.util.Collection<? extends java.lang.Boolean> 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.
 BooleanListIterator booleanListIterator()
          Deprecated. 
 BooleanListIterator booleanListIterator(int index)
          Deprecated. 
 BooleanList booleanSubList(int from, int to)
          Deprecated. 
 int compareTo(java.util.List<? extends java.lang.Boolean> l)
          Compares this list to another object.
 boolean contains(boolean k)
           
 boolean equals(java.lang.Object o)
           
 java.lang.Boolean 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(java.lang.Object ok)
          Delegates to the corresponding type-specific method.
 BooleanIterator iterator()
          Returns a type-specific iterator on the elements of this collection.
 int lastIndexOf(boolean k)
           
 int lastIndexOf(java.lang.Object ok)
          Delegates to the corresponding type-specific method.
 BooleanListIterator listIterator()
          Returns a type-specific list iterator on the list.
 BooleanListIterator listIterator(int index)
          Returns a type-specific list iterator on the list starting at a given index.
 java.lang.Boolean peek(int i)
          Delegates to the corresponding type-specific method.
 boolean peekBoolean(int i)
           
 java.lang.Boolean pop()
          Delegates to the corresponding type-specific method.
 boolean popBoolean()
           
 void push(boolean o)
           
 void push(java.lang.Boolean 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.
 java.lang.Boolean remove(int index)
          Delegates to the corresponding type-specific method.
 boolean remove(java.lang.Object o)
          Delegates to rem().
 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)
           
 java.lang.Boolean set(int index, java.lang.Boolean ok)
          Delegates to the corresponding type-specific method.
 void size(int size)
          Sets the size of this list.
 BooleanList subList(int from, int to)
          Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
 java.lang.Boolean top()
          Delegates to the corresponding type-specific method.
 boolean topBoolean()
           
 java.lang.String toString()
           
 
Methods inherited from class it.unimi.dsi.fastutil.booleans.AbstractBooleanCollection
add, booleanIterator, clear, contains, containsAll, containsAll, isEmpty, rem, 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, removeAll, retainAll, size, toArray, toArray
 
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection
booleanIterator, containsAll, removeAll, retainAll, toArray, 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
See Also:
Collection.add(Object)

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,
                      java.util.Collection<? extends java.lang.Boolean> c)
Specified by:
addAll in interface java.util.List<java.lang.Boolean>

addAll

public boolean addAll(java.util.Collection<? extends java.lang.Boolean> c)
Delegates to a more generic method.

Specified by:
addAll in interface java.util.Collection<java.lang.Boolean>
Specified by:
addAll in interface java.util.List<java.lang.Boolean>
Overrides:
addAll in class AbstractBooleanCollection
Parameters:
c - a collection.
Returns:
true if this collection changed as a result of the call.

booleanListIterator

@Deprecated
public BooleanListIterator booleanListIterator()
Deprecated. 

Delegates to the new covariantly stronger generic method.

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

booleanListIterator

@Deprecated
public BooleanListIterator booleanListIterator(int index)
Deprecated. 

Delegates to the new covariantly stronger generic method.

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

iterator

public BooleanIterator iterator()
Description copied from interface: BooleanCollection
Returns a type-specific iterator on the elements of this collection.

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

Specified by:
iterator in interface BooleanCollection
Specified by:
iterator in interface BooleanIterable
Specified by:
iterator in interface BooleanList
Specified by:
iterator in interface java.lang.Iterable<java.lang.Boolean>
Specified by:
iterator in interface java.util.Collection<java.lang.Boolean>
Specified by:
iterator in interface java.util.List<java.lang.Boolean>
Specified by:
iterator in class AbstractBooleanCollection
Returns:
a type-specific iterator on the elements of this collection.

listIterator

public BooleanListIterator listIterator()
Description copied from interface: BooleanList
Returns a type-specific list iterator on the list.

Specified by:
listIterator in interface BooleanList
Specified by:
listIterator in interface java.util.List<java.lang.Boolean>
See Also:
BooleanList.listIterator()

listIterator

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

Specified by:
listIterator in interface BooleanList
Specified by:
listIterator in interface java.util.List<java.lang.Boolean>
See Also:
BooleanList.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.

subList

public BooleanList subList(int from,
                           int to)
Description copied from interface: BooleanList
Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

Note that this specification strengthens the one given in List.subList(int,int).

Specified by:
subList in interface BooleanList
Specified by:
subList in interface java.util.List<java.lang.Boolean>
See Also:
List.subList(int,int)

booleanSubList

@Deprecated
public BooleanList booleanSubList(int from,
                                             int to)
Deprecated. 

Delegates to the new covariantly stronger generic method.

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

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(java.lang.Object o)
Specified by:
equals in interface java.util.Collection<java.lang.Boolean>
Specified by:
equals in interface java.util.List<java.lang.Boolean>
Overrides:
equals in class java.lang.Object

compareTo

public int compareTo(java.util.List<? extends java.lang.Boolean> l)
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 java.lang.Comparable<java.util.List<? extends java.lang.Boolean>>
Parameters:
l - an list.
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:
java.lang.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 java.util.Collection<java.lang.Boolean>
Specified by:
hashCode in interface java.util.List<java.lang.Boolean>
Overrides:
hashCode in class java.lang.Object
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)

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
See Also:
Collection.remove(Object)

remove

public boolean remove(java.lang.Object o)
Delegates to rem().

Specified by:
remove in interface java.util.Collection<java.lang.Boolean>
Specified by:
remove in interface java.util.List<java.lang.Boolean>
Overrides:
remove in class AbstractBooleanCollection

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(BooleanCollection c)
Description copied from class: AbstractBooleanCollection
Adds all elements of the given type-specific collection to this collection.

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.
See Also:
Collection.addAll(Collection)

addAll

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

add

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

Specified by:
add in interface java.util.List<java.lang.Boolean>

set

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

Specified by:
set in interface java.util.List<java.lang.Boolean>

get

public java.lang.Boolean get(int index)
Delegates to the corresponding type-specific method.

Specified by:
get in interface java.util.List<java.lang.Boolean>

indexOf

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

Specified by:
indexOf in interface java.util.List<java.lang.Boolean>

lastIndexOf

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

Specified by:
lastIndexOf in interface java.util.List<java.lang.Boolean>

remove

public java.lang.Boolean remove(int index)
Delegates to the corresponding type-specific method.

Specified by:
remove in interface java.util.List<java.lang.Boolean>

push

public void push(java.lang.Boolean o)
Delegates to the corresponding type-specific method.

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

pop

public java.lang.Boolean pop()
Delegates to the corresponding type-specific method.

Specified by:
pop in interface Stack<java.lang.Boolean>
Returns:
the top of the stack.

top

public java.lang.Boolean top()
Delegates to the corresponding type-specific method.

Specified by:
top in interface Stack<java.lang.Boolean>
Returns:
the top of the stack.

peek

public java.lang.Boolean peek(int i)
Delegates to the corresponding type-specific method.

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

toString

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