BaseList<E> class abstract

A base class intended to be extended by higher-level implementations of List.

Implemented types

• List<E>

Available extensions

• EnumByName
• FutureIterable
• IterableExtensions
• IterableUtilities
• ListToJSArray
• ListUtilities
• NullableIterableExtensions

Constructors

BaseList(List<E> elements, {required bool growable})

A base class intended to be extended by higher-level implementations of List.

const

Properties

elements → List<E>

The underlying List containing all of the elements in this list.

final

first ↔ E

The first element.

getter/setter pair, override

firstOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The first element of this iterator, or null if the iterable is empty.

no setter

growable → bool

If true, this list is growable; otherwise, this is a fixed-length list.

final

hashCode → int

The hash code for this object.

no setter, inherited

indexed → Iterable<(int, T)>

Available on Iterable<T>, provided by the IterableExtensions extension

Pairs of elements of the indices and elements of this iterable.

no setter

isEmpty → bool

Whether this collection has no elements.

no setter, override

isNotEmpty → bool

Whether this collection has at least one element.

no setter, override

iterator → Iterator<E>

A new Iterator that allows iterating the elements of this Iterable.

no setter, override

last ↔ E

The last element.

getter/setter pair, override

lastOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The last element of this iterable, or null if the iterable is empty.

no setter

length ↔ int

The number of objects in this list.

getter/setter pair, override

nonNulls → Iterable<T>

Available on Iterable<T?>, provided by the NullableIterableExtensions extension

The non-null elements of this iterable.

no setter

reversed → Iterable<E>

An Iterable of the objects in this list in reverse order.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

single → E

Checks that this iterable has only one element, and returns that element.

no setter, override

singleOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The single element of this iterator, or null.

no setter

toJS → JSArray<T>

Available on List<T>, provided by the ListToJSArray extension

Converts this List to a JSArray by either casting, unwrapping, or cloning the List.

no setter

toJSProxyOrRef → JSArray<T>

Available on List<T>, provided by the ListToJSArray extension

Converts this List to a JSArray by either casting, unwrapping, or proxying the List.

no setter

wait → Future<List<T>>

Available on Iterable<Future<T>>, provided by the FutureIterable extension

Waits for futures in parallel.

no setter

Methods

add(E value) → void

Adds value to the end of this list, extending the length by one.

override

addAll(Iterable<E> iterable) → void

Appends all objects of iterable to the end of this list.

override

any(Test<E> test) → bool

Checks whether any element of this iterable satisfies test.

override

asMap() → Map<int, E>

An unmodifiable Map view of this list.

override

asNameMap() → Map<String, T>

Available on Iterable<T>, provided by the EnumByName extension

Creates a map from the names of enum values to the values.

byName(String name) → T

Available on Iterable<T>, provided by the EnumByName extension

Finds the enum value in this list with name name.

cast<R>() → List<R>

Returns a view of this list as a list of R instances.

inherited

clear() → void

Removes all objects from this list; the length of the list becomes zero.

override

contains(Object? element) → bool

Whether the collection contains an element equal to element.

override

count(T object) → int

Available on List<T>, provided by the ListUtilities extension

Returns the number of instances there are of object in this list.

elementAt(int index) → E

Returns the indexth element.

override

elementAtOrNull(int index) → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The element at position index of this iterable, or null.

every(Test<E> test) → bool

Checks whether every element of this iterable satisfies test.

override

exclude(Iterable<T> subset) → List<T>

Available on List<T>, provided by the ListUtilities extension

Returns a new list containing all of the elements in this list that aren't also contained within subset.

excludeByIndex(Iterable<int> indexes) → List<T>

Available on List<T>, provided by the ListUtilities extension

Returns a sublist containing every element in this list, excluding those at the defined indexes.

expand<T>(Expand<T, E> f) → Iterable<T>

Expands each element of this Iterable into zero or more elements.

override

fillRange(int start, int end, [E? fillValue]) → void

Overwrites a range of elements with fillValue.

override

firstWhere(Test<E> test, {OrElse<E>? orElse}) → E

The first element that satisfies the given predicate test.

override

fold<T>(T initialValue, Fold<T, E> combine) → T

Reduces a collection to a single value by iteratively combining each element of the collection with an existing value

override

followedBy(Iterable<E> other) → Iterable<E>

Creates the lazy concatenation of this iterable and other.

override

forEach(ForEach<E> f) → void

Invokes action on each element of this iterable in iteration order.

override

getRandom(int count, [int? seed]) → List<T>

Available on List<T>, provided by the ListUtilities extension

Returns a new list containing random elements from this list.

getRange(int start, int end) → Iterable<E>

Creates an Iterable that iterates over a range of elements.

override

indexOf(E element, [int start = 0]) → int

The first index of element in this list.

override

indexWhere(Test<E> test, [int start = 0]) → int

The first index in the list that satisfies the provided test.

override

insert(int index, E element) → void

Inserts element at position index in this list.

override

insertAll(int index, Iterable<E> iterable) → void

Inserts all objects of iterable at position index in this list.

override

join([String separator = '']) → String

Converts each element to a String and concatenates the strings.

override

lastIndexOf(E element, [int? start]) → int

The last index of element in this list.

override

lastIndexWhere(Test<E> test, [int? start]) → int

The last index in the list that satisfies the provided test.

override

lastWhere(Test<E> test, {OrElse<E>? orElse}) → E

The last element that satisfies the given predicate test.

override

map<T>(Mapper<T, E> f) → Iterable<T>

The current elements of this iterable modified by toElement.

override

matches(Iterable<T> other, {bool ordered = false}) → bool

Available on Iterable<T>, provided by the IterableUtilities extension

Returns true if this and other are the same length and contain all of the same elements.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pluck(int start, [int? end]) → List<T>

Available on List<T>, provided by the ListUtilities extension

Removes and returns a range of elements from this list.

random([int? seed]) → T

Available on Iterable<T>, provided by the IterableUtilities extension

Returns a random value from the iterable.

reduce(Combine<E> combine) → E

Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.

override

remove(Object? value) → bool

Removes the first occurrence of value from this list.

override

removeAt(int index) → E

Removes the object at position index from this list.

override

removeFirst() → T

Available on List<T>, provided by the ListUtilities extension

Removes the first element in this list.

removeFirstWhere(ListTester<T> test) → bool

Available on List<T>, provided by the ListUtilities extension

Removes the first element in this list that satisfies test.

removeFrom(int index, int count) → void

Available on List<T>, provided by the ListUtilities extension

Removes the number of elements defined by count, starting from index.

removeFromEnd(int count) → void

Available on List<T>, provided by the ListUtilities extension

Removes the number of elements defined by count from the end of the list.

removeLast() → E

Removes and returns the last object in this list.

override

removeLastWhere(ListTester<T> test) → bool

Available on List<T>, provided by the ListUtilities extension

Removes the last element in this list that satisfies test.

removeNull() → void

Available on List<T>, provided by the ListUtilities extension

Removes all null values from this list.

removeRandom([int? seed]) → T

Available on List<T>, provided by the ListUtilities extension

Removes and returns a random value from this list.

removeRange(int start, int end) → void

Removes a range of elements from the list.

override

removeWhere(Test<E> test) → void

Removes all objects from this list that satisfy test.

override

replaceRange(int start, int end, Iterable<E> replacement) → void

Replaces a range of elements with the elements of replacements.

override

resizeAndFill(int resizeBy, T fill) → void

Available on List<T>, provided by the ListUtilities extension

Resizes the list by resizeBy, setting the new elements to fill if resizeBy is positive, otherwise removing elements if resizeBy is negative.

resizeAndGenerate(int resizeBy, ListGenerator<T> generator) → void

Available on List<T>, provided by the ListUtilities extension

Resizes the list by resizeBy, setting the new elements with the generator if resizeBy is positive, otherwise removing elements if resizeBy is negative.

retainWhere(Test<E> test) → void

Removes all objects from this list that fail to satisfy test.

override

setAll(int index, Iterable<E> iterable) → void

Overwrites elements with the objects of iterable.

override

setRange(int start, int end, Iterable<E> iterable, [int skipCount = 0]) → void

Writes some elements of iterable into a range of this list.

override

shift(int amount) → void

Available on List<T>, provided by the ListUtilities extension

Shifts the order of the elements by the provided amount.

shuffle([Random? random]) → void

Shuffles the elements of this list randomly.

override

singleWhere(Test<E> test, {OrElse<E>? orElse}) → E

The single element that satisfies test.

override

skip(int count) → Iterable<E>

Creates an Iterable that provides all but the first count elements.

override

skipWhile(Test<E> test) → Iterable<E>

Creates an Iterable that skips leading elements while test is satisfied.

override

sort([Compare<E>? compare]) → void

Sorts this list according to the order specified by the compare function.

override

sublist(int start, [int? end]) → List<E>

Returns a new list containing the elements between start and end.

override

take(int count) → Iterable<E>

Creates a lazy iterable of the count first elements of this iterable.

override

takeWhile(Test<E> test) → Iterable<E>

Creates a lazy iterable of the leading elements satisfying test.

override

toList({bool growable = true}) → List<E>

Creates a List containing the elements of this Iterable.

override

toSet() → Set<E>

Creates a Set containing the same elements as this iterable.

override

toString() → String

A string representation of this object.

override

transform(int index, ListTransformer<T> transformer) → void

Available on List<T>, provided by the ListUtilities extension

Updates the element at index to the value returned by transformer.

transformAll(ListTransformer<T> transformer) → void

Available on List<T>, provided by the ListUtilities extension

Updates every element in the list to the value returned by transformer.

where(Test<E> test) → Iterable<E>

Creates a new lazy Iterable with all elements that satisfy the predicate test.

override

whereType<T>() → Iterable<T>

Creates a new lazy Iterable with all elements that have type T.

override

Operators

operator +(List<E> other) → List<E>

Returns the concatenation of this list and other.

override

operator +(Iterable<T> other) → Iterable<T>

Available on Iterable<T>, provided by the IterableUtilities extension

Returns a new Iterable of the same type as this with other's elements appended to the end.

operator ==(Object other) → bool

The equality operator.

inherited

operator [](int index) → E

The object at the given index in the list.

override

operator []=(int index, E value) → void

Sets the value at the given index in the list to value.

override