class
Set<E>

A collection of objects in which each object can occur only once.

That is, for each object of the element type, the object is either considered to be in the set, or to not be in the set.

Set implementations may consider some elements indistinguishable. These elements are treated as being the same for any operation on the set.

The default Set implementation, LinkedHashSet, considers objects indistinguishable if they are equal with regard to operator Object.==.

Iterating over elements of a set may be either unordered or ordered in some way. Examples:

  • A HashSet is unordered, which means that its iteration order is uspecified,

  • LinkedHashSet iterates in the insertion order of its elements, and
  • a sorted set like SplayTreeSet iterates the elements in sorted order.

It is generally not allowed to modify the set (add or remove elements) while an operation on the set is being performed, for example during a call to forEach or containsAll. Nor is it allowed to modify the set while iterating either the set itself or any Iterable that is backed by the set, such as the ones returned by methods like where and map.

Extends
Implements
  • EfficientLength
Implemented by

Properties

Iterator<E> iterator
read-only
Provides an iterator that iterates over the elements of this set.
int length
read-only , inherited
Returns the number of elements in [this].
bool isEmpty
read-only , inherited
Returns true if there are no elements in this collection.
bool isNotEmpty
read-only , inherited
Returns true if there is at least one element in this collection.
E first
read-only , inherited
Returns the first element.
E last
read-only , inherited
Returns the last element.
E single
read-only , inherited
Checks that this iterable has only one element, and returns that element.
E first
read-only , inherited
Returns the first element.
E last
read-only , inherited
Returns the last element.
E single
read-only , inherited
Checks that this iterable has only one element, and returns that element.

Constructors

Set()
Creates an empty Set.
Set.identity()
Creates an empty identity Set.
Set.from(Iterable elements)
Creates a Set that contains all elements.

Methods

contains(Object value) → bool
Returns true if value is in the set.
add(E value) → bool
Adds value into the set. Returns true if value was added to the set.
addAll(Iterable<E> elements) → void
Adds all elements to this Set.
remove(Object value) → 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.
lookup(Object object) → E
If an object equal to object is in the set, return it.
removeAll(Iterable<Object> elements) → void
Removes each element of elements from this set.
retainAll(Iterable<Object> elements) → void
Removes all elements of this set that are not elements in elements.
removeWhere(bool test(E element)) → void
Removes all elements of this set that satisfy test.
retainWhere(bool test(E element)) → void
Removes all elements of this set that fail to satisfy test.
containsAll(Iterable<Object> other) → bool
Returns whether this Set contains all the elements of other.
intersection(Set<Object> other) → Set<E>
Returns a new set which is the intersection between this set and other.
union(Set<E> other) → Set<E>
Returns a new set which contains all the elements of this set and other.
difference(Set<E> other) → Set<E>
Returns a new set with the the elements of this that are not in other.
clear() → void
Removes all elements in the set.
toSet() → Set<E>
Creates a [Set] containing the same elements as this iterable.
toString() → String
inherited
Returns a string representation of (some of) the elements of this.
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.
where(bool f(E element)) → Iterable<E>
inherited
Returns a new lazy Iterable with all elements that satisfy the predicate test.
expand(Iterable f(E element)) → Iterable
inherited
Expands each element of this Iterableinto zero or more elements.
forEach(void f(E element)) → void
inherited
Applies the function f to each element of this collection in iteration order.
reduce(E combine(E value, 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
every(bool f(E element)) → bool
inherited
Checks whether every element of this iterable satisfies test.
join([String separator = ""]) → String
inherited
Converts each element to a String and concatenates the strings.
any(bool f(E element)) → bool
inherited
Checks whether any element of this iterable satisfies test.
toList({bool growable: true}) → List<E>
inherited
Creates a List containing the elements of this Iterable.
take(int n) → Iterable<E>
inherited
Returns a lazy iterable of the count first elements of this iterable.
takeWhile(bool test(E value)) → Iterable<E>
inherited
Returns a lazy iterable of the leading elements satisfying test.
skip(int n) → Iterable<E>
inherited
Returns an Iterable that provides all but the first count elements.
skipWhile(bool test(E value)) → Iterable<E>
inherited
Returns an Iterable that skips leading elements while test is satisfied.
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.
elementAt(int index) → E
inherited
Returns the indexth element.
take(int n) → 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.
takeWhile(bool test(E value)) → 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
firstWhere(bool test(E element), {E orElse()}) → E
inherited
Returns the first element that satisfies the given predicate test.
forEach(void f(E element)) → void
inherited
Applies the function f to each element of this collection in iteration order.
skipWhile(bool test(E value)) → Iterable<E>
inherited
Returns an Iterable that skips leading elements while test is satisfied.
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.
reduce(E combine(E value, E element)) → E
inherited
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
every(bool f(E element)) → bool
inherited
Checks whether every element of this iterable satisfies test.
any(bool f(E element)) → bool
inherited
Checks whether any element of this iterable satisfies test.
toList({bool growable: true}) → List<E>
inherited
Creates a List containing the elements of this Iterable.
where(bool f(E element)) → Iterable<E>
inherited
Returns a new lazy Iterable with all elements that satisfy the predicate test.
skip(int n) → 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 Iterableinto zero or more elements.
elementAt(int index) → E
inherited
Returns the indexth element.