SetBase abstract class

Base 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 base class 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 base should consider also implementing clear in constant time. The default implementation works by removing every element.

Inheritance

Static Methods

setToString(Set set) → String

Convert a Set to a string as {each, element, as, string}.

Constructors

SetBase()

Properties

first → E
read-only, inherited
hashCodeint
read-only, inherited

The hash code for this object.

isEmptybool
read-only, inherited
isNotEmptybool
read-only, inherited
iteratorIterator<E>
read-only, inherited
last → E
read-only, inherited
lengthint
read-only, inherited
runtimeTypeType
read-only, inherited

A representation of the runtime type of the object.

single → E
read-only, inherited

Operators

operator ==(other) → bool
inherited

The equality operator.

Methods

add(E element) → bool
inherited

Adds value to the set.

addAll(Iterable<E> elements) → void
inherited

Adds all elements to this Set.

any(bool test(E element)) → bool
inherited

Checks whether any element of this iterable satisfies test.

clear() → void
inherited

Removes all elements in the set.

contains(Object element) → bool
inherited

Returns true if value is in the set.

containsAll(Iterable<Object> other) → bool
inherited

Returns whether this Set contains all the elements of other.

difference(Set<Object> other) → Set<E>
inherited

Returns a new set with the elements of this that are not in other.

elementAt(int index) → E
inherited

Returns the indexth element.

every(bool f(E element)) → bool
inherited

Checks whether every element of this iterable satisfies test.

expand<T>(Iterable<T> f(E element)) → Iterable<T>
inherited

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

firstWhere(bool test(E value), { E orElse() }) → E
inherited

Returns the first element that satisfies the given predicate test.

fold<T>(T initialValue, T combine(T previousValue, E element)) → T
inherited

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
inherited

Applies the function f to each element of this collection in iteration order.

intersection(Set<Object> other) → Set<E>
inherited

Returns a new set which is the intersection between this set and other.

join([String separator = "" ]) → String
inherited

Converts each element to a String and concatenates the strings.

lastWhere(bool test(E value), { E orElse() }) → E
inherited

Returns the last element that satisfies the given predicate test.

lookup(Object element) → E
inherited

If an object equal to object is in the set, return it.

map<T>(T f(E element)) → Iterable<T>
inherited

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
inherited

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

remove(Object element) → bool
inherited

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
inherited

Removes each element of elements from this set.

removeWhere(bool test(E element)) → void
inherited

Removes all elements of this set that satisfy test.

retainAll(Iterable<Object> elements) → void
inherited

Removes all elements of this set that are not elements in elements.

retainWhere(bool test(E element)) → void
inherited

Removes all elements of this set that fail to satisfy test.

singleWhere(bool test(E value)) → E
inherited

Returns the single element that satisfies 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.

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.

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

Creates a List containing the elements of this Iterable.

toSet() → Set<E>
inherited

Creates a Set containing the same elements as this iterable.

toString() → String
inherited

Returns a string representation of this object.

union(Set<E> other) → Set<E>
inherited

Returns a new set which contains all the elements of this set and other.

where(bool f(E element)) → Iterable<E>
inherited

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

© 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/SetBase-class.html