Set<E> class

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

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:

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
Implementors

Constructors

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

Instance Properties

iterator Iterator<E>
read-only
length int Inherited
read-only
isEmpty bool Inherited
read-only
isNotEmpty bool Inherited
read-only
first E Inherited
read-only
last E Inherited
read-only
single E Inherited
read-only
first E Inherited
read-only
last E Inherited
read-only
single E Inherited
read-only

Instance 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 Inherited ( ) → String
Returns a string representation of (some of) the elements of this.
map Inherited ( dynamic f(E element) ) → Iterable
Returns a new lazy Iterable with elements that are created by calling f on each element of this Iterable in iteration order.
where Inherited ( bool f(E element) ) → Iterable<E>
Returns a new lazy Iterable with all elements that satisfy the predicate test.
expand Inherited ( Iterable f(E element) ) → Iterable
Expands each element of this Iterableinto zero or more elements.
forEach Inherited ( void f(E element) ) → void
Applies the function f to each element of this collection in iteration order.
reduce Inherited ( 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.
fold Inherited ( initialValue, dynamic combine(previousValue, E element) ) → dynamic
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
every Inherited ( bool f(E element) ) → bool
Checks whether every element of this iterable satisfies test.
join Inherited ( [String separator = ""] ) → String
Converts each element to a String and concatenates the strings.
any Inherited ( bool f(E element) ) → bool
Checks whether any element of this iterable satisfies test.
toList Inherited ( {bool growable: true} ) → List<E>
Creates a List containing the elements of this Iterable.
take Inherited ( int n ) → Iterable<E>
Returns a lazy iterable of the count first elements of this iterable.
takeWhile Inherited ( bool test(E value) ) → Iterable<E>
Returns a lazy iterable of the leading elements satisfying test.
skip Inherited ( int n ) → Iterable<E>
Returns an Iterable that provides all but the first count elements.
skipWhile Inherited ( bool test(E value) ) → Iterable<E>
Returns an Iterable that skips leading elements while test is satisfied.
firstWhere Inherited ( bool test(E element), {E orElse()} ) → E
Returns the first element that satisfies the given predicate test.
lastWhere Inherited ( bool test(E element), {E orElse()} ) → E
Returns the last element that satisfies the given predicate test.
singleWhere Inherited ( bool test(E element) ) → E
Returns the single element that satisfies test.
elementAt Inherited ( int index ) → E
Returns the indexth element.
take Inherited ( int n ) → Iterable<E>
Returns a lazy iterable of the count first elements of this iterable.
map Inherited ( dynamic f(E element) ) → Iterable
Returns a new lazy Iterable with elements that are created by calling f on each element of this Iterable in iteration order.
takeWhile Inherited ( bool test(E value) ) → Iterable<E>
Returns a lazy iterable of the leading elements satisfying test.
fold Inherited ( initialValue, dynamic combine(previousValue, E element) ) → dynamic
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
firstWhere Inherited ( bool test(E element), {E orElse()} ) → E
Returns the first element that satisfies the given predicate test.
forEach Inherited ( void f(E element) ) → void
Applies the function f to each element of this collection in iteration order.
skipWhile Inherited ( bool test(E value) ) → Iterable<E>
Returns an Iterable that skips leading elements while test is satisfied.
lastWhere Inherited ( bool test(E element), {E orElse()} ) → E
Returns the last element that satisfies the given predicate test.
singleWhere Inherited ( bool test(E element) ) → E
Returns the single element that satisfies test.
reduce Inherited ( 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.
every Inherited ( bool f(E element) ) → bool
Checks whether every element of this iterable satisfies test.
any Inherited ( bool f(E element) ) → bool
Checks whether any element of this iterable satisfies test.
toList Inherited ( {bool growable: true} ) → List<E>
Creates a List containing the elements of this Iterable.
where Inherited ( bool f(E element) ) → Iterable<E>
Returns a new lazy Iterable with all elements that satisfy the predicate test.
skip Inherited ( int n ) → Iterable<E>
Returns an Iterable that provides all but the first count elements.
expand Inherited ( Iterable f(E element) ) → Iterable
Expands each element of this Iterableinto zero or more elements.
elementAt Inherited ( int index ) → E
Returns the indexth element.