it.unimi.dsi.fastutil.booleans
Interface BooleanList

All Superinterfaces:
BooleanCollection, BooleanIterable, java.util.Collection<java.lang.Boolean>, java.lang.Comparable<java.util.List<? extends java.lang.Boolean>>, java.lang.Iterable<java.lang.Boolean>, java.util.List<java.lang.Boolean>
All Known Implementing Classes:
AbstractBooleanList, AbstractBooleanList.BooleanSubList, BooleanArrayList, BooleanLists.EmptyList, BooleanLists.Singleton, BooleanLists.SynchronizedList, BooleanLists.UnmodifiableList

public interface BooleanList
extends java.util.List<java.lang.Boolean>, java.lang.Comparable<java.util.List<? extends java.lang.Boolean>>, BooleanCollection

A type-specific List; provides some additional methods that use polymorphism to avoid (un)boxing.

Note that this type-specific interface extends Comparable: it is expected that implementing classes perform a lexicographical comparison using the standard operator "less then" for primitive types, and the usual compareTo() method for objects.

Additionally, this interface strengthens listIterator(), listIterator(int) and subList(int,int).

Besides polymorphic methods, this interfaces specifies methods to copy into an array or remove contiguous sublists. Although the abstract implementation of this interface provides simple, one-by-one implementations of these methods, it is expected that concrete implementation override them with optimized versions.

See Also:
List

Method Summary
 void add(int index, boolean key)
           
 boolean addAll(BooleanList c)
           
 boolean addAll(int index, BooleanCollection c)
           
 boolean addAll(int index, BooleanList 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)
          Add (hopefully quickly) elements to this type-specific list.
 BooleanListIterator booleanListIterator()
          Deprecated. As of fastutil 5, replaced by listIterator().
 BooleanListIterator booleanListIterator(int index)
          Deprecated. As of fastutil 5, replaced by listIterator(int).
 BooleanList booleanSubList(int from, int to)
          Deprecated. As of fastutil 5, replaced by subList(int,int).
 boolean getBoolean(int index)
           
 void getElements(int from, boolean[] a, int offset, int length)
          Copies (hopefully quickly) elements of this type-specific list into the given array.
 int indexOf(boolean k)
           
 BooleanIterator iterator()
          Returns a type-specific iterator on the elements of this list (in proper sequence).
 int lastIndexOf(boolean k)
           
 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.
 boolean removeBoolean(int index)
           
 void removeElements(int from, int to)
          Removes (hopefully quickly) elements of this type-specific list.
 boolean set(int index, boolean k)
           
 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.
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, lastIndexOf, remove, remove, removeAll, retainAll, set, size, toArray, toArray
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection
add, addAll, booleanIterator, contains, containsAll, rem, removeAll, retainAll, toArray, toArray, toBooleanArray, toBooleanArray
 

Method Detail

iterator

BooleanIterator iterator()
Returns a type-specific iterator on the elements of this list (in proper sequence). Note that this specification strengthens the one given in List.iterator(). It would not be normally necessary, but Iterable.iterator() is bizarrily re-specified in List.

Specified by:
iterator in interface BooleanCollection
Specified by:
iterator in interface BooleanIterable
Specified by:
iterator in interface java.util.Collection<java.lang.Boolean>
Specified by:
iterator in interface java.lang.Iterable<java.lang.Boolean>
Specified by:
iterator in interface java.util.List<java.lang.Boolean>
Returns:
an iterator on the elements of this list (in proper sequence).

booleanListIterator

@Deprecated
BooleanListIterator booleanListIterator()
Deprecated. As of fastutil 5, replaced by listIterator().

Returns a type-specific list iterator on the list.

See Also:
listIterator()

booleanListIterator

@Deprecated
BooleanListIterator booleanListIterator(int index)
Deprecated. As of fastutil 5, replaced by listIterator(int).

Returns a type-specific list iterator on the list starting at a given index.

See Also:
listIterator(int)

listIterator

BooleanListIterator listIterator()
Returns a type-specific list iterator on the list.

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

listIterator

BooleanListIterator listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.

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

booleanSubList

@Deprecated
BooleanList booleanSubList(int from,
                                      int to)
Deprecated. As of fastutil 5, replaced by subList(int,int).

Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

See Also:
List.subList(int,int)

subList

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.

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

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

size

void size(int size)
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.

Parameters:
size - the new size.

getElements

void getElements(int from,
                 boolean[] a,
                 int offset,
                 int length)
Copies (hopefully quickly) elements of this type-specific list into the given array.

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.

removeElements

void removeElements(int from,
                    int to)
Removes (hopefully quickly) elements of this type-specific list.

Parameters:
from - the start index (inclusive).
to - the end index (exclusive).

addElements

void addElements(int index,
                 boolean[] a)
Add (hopefully quickly) elements to this type-specific list.

Parameters:
index - the index at which to add elements.
a - the array containing the elements.

addElements

void addElements(int index,
                 boolean[] a,
                 int offset,
                 int length)
Add (hopefully quickly) elements to this type-specific list.

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.

add

void add(int index,
         boolean key)
See Also:
List.add(int,Object)

addAll

boolean addAll(int index,
               BooleanCollection c)
See Also:
List.add(int,Object)

addAll

boolean addAll(int index,
               BooleanList c)
See Also:
List.add(int,Object)

addAll

boolean addAll(BooleanList c)
See Also:
List.add(int,Object)

getBoolean

boolean getBoolean(int index)
See Also:
List.get(int)

indexOf

int indexOf(boolean k)
See Also:
List.indexOf(Object)

lastIndexOf

int lastIndexOf(boolean k)
See Also:
List.lastIndexOf(Object)

removeBoolean

boolean removeBoolean(int index)
See Also:
List.remove(int)

set

boolean set(int index,
            boolean k)
See Also:
List.set(int,Object)