SetMixin<E> class

Mixin implementation of Set.

This class provides a base implementation of a Set that depends only on the abstract members: add, contains, lookup, remove, iterator, length and toSet.

Some of the methods assume that toSet creates a modifiable set. If using this mixin for an unmodifiable set, where toSet should return an unmodifiable set, it's necessary to reimplement retainAll, union, intersection and difference.

Implementations of Set using this mixin should consider also implementing clear in constant time. The default implementation works by removing every element.

Implemented types

Set<E>

Implementers

Constructors

SetMixin()

Properties

first → E read-only, override: Returns the first element. [...]
hashCode → int read-only, inherited: The hash code for this object. [...]
isEmpty → bool read-only, override: Returns true if there are no elements in this collection. [...]
isNotEmpty → bool read-only, override: Returns true if there is at least one element in this collection. [...]
iterator → Iterator<E> read-only, override: An iterator that iterates over the elements of this set. [...]
last → E read-only, override: Returns the last element. [...]
length → int read-only: Returns the number of elements in the iterable. [...]
runtimeType → Type read-only, inherited: A representation of the runtime type of the object.
single → E read-only, override: Checks that this iterable has only one element, and returns that element. [...]

Methods

add(E value) → bool override: Adds value to the set. [...]
addAll(Iterable<E> elements) → void override: Adds all elements to this set. [...]
any(bool test(E element)) → bool override: Checks whether any element of this iterable satisfies test. [...]
cast<R>() → Set<R> override: Provides a view of this set as a set of R instances. [...]
clear() → void override: Removes all elements from the set.
contains(Object? element) → bool override: Whether value is in the set.
containsAll(Iterable<Object?> other) → bool override: Whether this set contains all the elements of other.
difference(Set<Object?> other) → Set<E> override: Creates a new set with the elements of this that are not in other. [...]
elementAt(int index) → E override: Returns the indexth element. [...]
every(bool f(E element)) → bool override: Checks whether every element of this iterable satisfies test. [...]
expand<T>(Iterable<T> f(E element)) → Iterable<T> override: Expands each element of this Iterable into zero or more elements. [...]
firstWhere(bool test(E value), {E orElse()}) → E override: Returns the first element that satisfies the given predicate test. [...]
fold<T>(T initialValue, T combine(T previousValue, E element)) → T override: Reduces a collection to a single value by iteratively combining each element of the collection with an existing value [...]
followedBy(Iterable<E> other) → Iterable<E> override: Returns the lazy concatenation of this iterable and other. [...]
forEach(void f(E element)) → void override: Applies the function f to each element of this collection in iteration order.
intersection(Set<Object?> other) → Set<E> override: Creates a new set which is the intersection between this set and other. [...]
join([String separator = ""]) → String override: Converts each element to a String and concatenates the strings. [...]
lastWhere(bool test(E value), {E orElse()}) → E override: Returns the last element that satisfies the given predicate test. [...]
lookup(Object? element) → E? override: If an object equal to object is in the set, return it. [...]
map<T>(T f(E element)) → Iterable<T> override: Returns a new lazy Iterable with elements that are created by calling f on each element of this Iterable in iteration order. [...]
noSuchMethod(Invocation invocation) → dynamic inherited: Invoked when a non-existent method or property is accessed. [...]
reduce(E combine(E value, E element)) → E override: Reduces a collection to a single value by iteratively combining elements of the collection using the provided function. [...]
remove(Object? value) → bool override: Removes value from the set. [...]
removeAll(Iterable<Object?> elements) → void override: Removes each element of elements from this set.
removeWhere(bool test(E element)) → void override: Removes all elements of this set that satisfy test.
retainAll(Iterable<Object?> elements) → void override: Removes all elements of this set that are not elements in elements. [...]
retainWhere(bool test(E element)) → void override: Removes all elements of this set that fail to satisfy test.
singleWhere(bool test(E value), {E orElse()}) → E override: Returns the single element that satisfies test. [...]
skip(int n) → Iterable<E> override: Returns an Iterable that provides all but the first count elements. [...]
skipWhile(bool test(E value)) → Iterable<E> override: Returns an Iterable that skips leading elements while test is satisfied. [...]
take(int n) → Iterable<E> override: Returns a lazy iterable of the count first elements of this iterable. [...]
takeWhile(bool test(E value)) → Iterable<E> override: Returns a lazy iterable of the leading elements satisfying test. [...]
toList({bool growable = true}) → List<E> override: Creates a List containing the elements of this Iterable. [...]
toSet() → Set<E> override: Creates a Set with the same elements and behavior as this Set. [...]
toString() → String override: A string representation of this object. [...]
union(Set<E> other) → Set<E> override: Creates a new set which contains all the elements of this set and other. [...]
where(bool f(E element)) → Iterable<E> override: Returns a new lazy Iterable with all elements that satisfy the predicate test. [...]
whereType<T>() → Iterable<T> override: Returns a new lazy Iterable with all elements that have type T. [...]

Operators

operator ==(Object other) → bool inherited: The equality operator. [...]

© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dart.dev/stable/2.13.0/dart-collection/SetMixin-class.html