SetMixin abstract 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.

Implements

Set<E>

Implemented by

Constructors

SetMixin()

Properties

first → E read-only
isEmpty → bool read-only
isNotEmpty → bool read-only
iterator → Iterator<E> read-only
last → E read-only
length → int read-only
single → E read-only
hashCode → int read-only, inherited: The hash code for this object.
runtimeType → Type read-only, inherited: A representation of the runtime type of the object.

Operators

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

Methods

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

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