class
ListBase<E>

Abstract implementation of a list.

ListBase can be used as a base class for implementing the List interface.

All operations are defined in terms of length, operator[], operator[]= and length=, which need to be implemented.

NOTICE: Forwarding just these four operations to a normal growable List (as created by new List()) will give very bad performance for add and addAll operations of ListBase. These operations are implemented by increasing the length of the list by one for each add operation, and repeatedly increasing the length of a growable list is not efficient. To avoid this, either override 'add' and 'addAll' to also forward directly to the growable list, or, preferably, use DelegatingList from "package:collection/wrappers.dart" instead.

Mixes-in
Implemented by

Static Methods

listToString(List list) → String
Convert a List to a string as each, element, as, string.

Properties

Iterator<E> iterator
read-only , inherited
bool isEmpty
read-only , inherited
bool isNotEmpty
read-only , inherited
E first
read-only , inherited
E last
read-only , inherited
E single
read-only , inherited
Iterable<E> reversed
read-only , inherited
E last
read-only , inherited
E single
read-only , inherited
int length
read / write , inherited
Returns the number of objects in this list.
Iterable<E> reversed
read-only , inherited
Iterator<E> iterator
read-only , inherited
E first
read-only , inherited

Constructors

ListBase()

Operators

operator []=(int index, E value) → void
inherited
Sets the value at the given index in the list to value or throws a RangeError if index is out of bounds.
operator [](int index) → E
inherited
Returns the object at the given index in the list or throws a RangeError if index is out of bounds.

Methods

toString() → String
inherited
Returns a string representation of this object.
elementAt(int index) → E
inherited
Returns the [index]th element.
forEach(void action(E element)) → void
inherited
Applies the function [f] to each element of this collection in iteration order.
contains(Object element) → bool
inherited
Returns true if the collection contains an element equal to [element].
every(bool test(E element)) → bool
inherited
Checks whether every element of this iterable satisfies [test].
any(bool test(E element)) → bool
inherited
Checks whether any element of this iterable satisfies [test].
firstWhere(bool test(E element), {E orElse()}) → E
inherited
Returns the first element that satisfies the given predicate [test].
lastWhere(bool test(E element), {E orElse()}) → E
inherited
Returns the last element that satisfies the given predicate [test].
singleWhere(bool test(E element)) → E
inherited
Returns the single element that satisfies [test].
join([String separator = ""]) → String
inherited
Converts each element to a [String] and concatenates the strings.
where(bool test(E element)) → Iterable<E>
inherited
Returns a new lazy [Iterable] with all elements that satisfy the predicate [test].
map(dynamic f(E element)) → Iterable
inherited
Returns a new lazy [Iterable] with elements that are created by calling f on each element of this Iterable in iteration order.
expand(Iterable f(E element)) → Iterable
inherited
Expands each element of this [Iterable]into zero or more elements.
reduce(E combine(E previousValue, E element)) → E
inherited
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
fold(initialValue, dynamic combine(previousValue, E element)) → dynamic
inherited
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
skip(int count) → Iterable<E>
inherited
Returns an Iterable that provides all but the first [count] elements.
skipWhile(bool test(E element)) → Iterable<E>
inherited
Returns an Iterable that skips leading elements while [test] is satisfied.
take(int count) → Iterable<E>
inherited
Returns a lazy iterable of the [count] first elements of this iterable.
takeWhile(bool test(E element)) → Iterable<E>
inherited
Returns a lazy iterable of the leading elements satisfying [test].
toList({bool growable: true}) → List<E>
inherited
Creates a [List] containing the elements of this [Iterable].
toSet() → Set<E>
inherited
Creates a [Set] containing the same elements as this iterable.
add(E element) → void
inherited
Adds [value] to the end of this list, extending the length by one.
addAll(Iterable<E> iterable) → void
inherited
Appends all objects of [iterable] to the end of this list.
remove(Object element) → bool
inherited
Removes the first occurence of [value] from this list.
removeWhere(bool test(E element)) → void
inherited
Removes all objects from this list that satisfy [test].
retainWhere(bool test(E element)) → void
inherited
Removes all objects from this list that fail to satisfy [test].
clear() → void
inherited
Removes all objects from this list; the length of the list becomes zero.
removeLast() → E
inherited
Pops and returns the last object in this list.
sort([int compare(E a, E b)]) → void
inherited
Sorts this list according to the order specified by the [compare] function.
shuffle([Random random]) → void
inherited
Shuffles the elements of this list randomly.
asMap() → Map<int,E>
inherited
Returns an unmodifiable [Map] view of this.
sublist(int start, [int end]) → List<E>
inherited
Returns a new list containing the objects from [start] inclusive to [end] exclusive.
getRange(int start, int end) → Iterable<E>
inherited
Returns an [Iterable] that iterates over the objects in the range [start] inclusive to [end] exclusive.
removeRange(int start, int end) → void
inherited
Removes the objects in the range [start] inclusive to [end] exclusive.
fillRange(int start, int end, [E fill]) → void
inherited
Sets the objects in the range [start] inclusive to [end] exclusive to the given [fillValue].
setRange(int start, int end, Iterable<E> iterable, [int skipCount = 0]) → void
inherited
Copies the objects of [iterable], skipping [skipCount] objects first, into the range [start], inclusive, to [end], exclusive, of the list.
replaceRange(int start, int end, Iterable<E> newContents) → void
inherited
Removes the objects in the range [start] inclusive to [end] exclusive and inserts the contents of [replacement] in its place.
indexOf(Object element, [int startIndex = 0]) → int
inherited
Returns the first index of [element] in this list.
lastIndexOf(Object element, [int startIndex]) → int
inherited
Returns the last index in the list a of the given element, starting the search at index startIndex to 0. Returns -1 if element is not found.
insert(int index, E element) → void
inherited
Inserts the object at position [index] in this list.
removeAt(int index) → E
inherited
Removes the object at position [index] from this list.
insertAll(int index, Iterable<E> iterable) → void
inherited
Inserts all objects of [iterable] at position [index] in this list.
setAll(int index, Iterable<E> iterable) → void
inherited
Overwrites objects of this with the objects of [iterable], starting at position [index] in this list.
insert(int index, E element) → void
inherited
Inserts the object at position [index] in this list.
take(int count) → Iterable<E>
inherited
Returns a lazy iterable of the [count] first elements of this iterable.
map(dynamic f(E element)) → Iterable
inherited
Returns a new lazy [Iterable] with elements that are created by calling f on each element of this Iterable in iteration order.
toSet() → Set<E>
inherited
Creates a [Set] containing the same elements as this iterable.
forEach(void action(E element)) → void
inherited
Applies the function [f] to each element of this collection in iteration order.
setAll(int index, Iterable<E> iterable) → void
inherited
Overwrites objects of this with the objects of [iterable], starting at position [index] in this list.
skipWhile(bool test(E element)) → Iterable<E>
inherited
Returns an Iterable that skips leading elements while [test] is satisfied.
setRange(int start, int end, Iterable<E> iterable, [int skipCount = 0]) → void
inherited
Copies the objects of [iterable], skipping [skipCount] objects first, into the range [start], inclusive, to [end], exclusive, of the list.
asMap() → Map<int,E>
inherited
Returns an unmodifiable [Map] view of this.
lastWhere(bool test(E element), {E orElse()}) → E
inherited
Returns the last element that satisfies the given predicate [test].
reduce(E combine(E previousValue, E element)) → E
inherited
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
every(bool test(E element)) → bool
inherited
Checks whether every element of this iterable satisfies [test].
any(bool test(E element)) → bool
inherited
Checks whether any element of this iterable satisfies [test].
where(bool test(E element)) → Iterable<E>
inherited
Returns a new lazy [Iterable] with all elements that satisfy the predicate [test].
sort([int compare(E a, E b)]) → void
inherited
Sorts this list according to the order specified by the [compare] function.
skip(int count) → Iterable<E>
inherited
Returns an Iterable that provides all but the first [count] elements.
expand(Iterable f(E element)) → Iterable
inherited
Expands each element of this [Iterable]into zero or more elements.
elementAt(int index) → E
inherited
Returns the [index]th element.
getRange(int start, int end) → Iterable<E>
inherited
Returns an [Iterable] that iterates over the objects in the range [start] inclusive to [end] exclusive.
removeAt(int index) → E
inherited
Removes the object at position [index] from this list.
takeWhile(bool test(E element)) → Iterable<E>
inherited
Returns a lazy iterable of the leading elements satisfying [test].
fold(initialValue, dynamic combine(previousValue, E element)) → dynamic
inherited
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
sublist(int start, [int end]) → List<E>
inherited
Returns a new list containing the objects from [start] inclusive to [end] exclusive.
firstWhere(bool test(E element), {E orElse()}) → E
inherited
Returns the first element that satisfies the given predicate [test].
add(E element) → void
inherited
Adds [value] to the end of this list, extending the length by one.
singleWhere(bool test(E element)) → E
inherited
Returns the single element that satisfies [test].
addAll(Iterable<E> iterable) → void
inherited
Appends all objects of [iterable] to the end of this list.
replaceRange(int start, int end, Iterable<E> newContents) → void
inherited
Removes the objects in the range [start] inclusive to [end] exclusive and inserts the contents of [replacement] in its place.
insertAll(int index, Iterable<E> iterable) → void
inherited
Inserts all objects of [iterable] at position [index] in this list.
removeWhere(bool test(E element)) → void
inherited
Removes all objects from this list that satisfy [test].
toList({bool growable: true}) → List<E>
inherited
Creates a [List] containing the elements of this [Iterable].
fillRange(int start, int end, [E fill]) → void
inherited
Sets the objects in the range [start] inclusive to [end] exclusive to the given [fillValue].
removeLast() → E
inherited
Pops and returns the last object in this list.
retainWhere(bool test(E element)) → void
inherited
Removes all objects from this list that fail to satisfy [test].