UnmodifiableCollectiveSet<E> class

An immutable version of CollectiveSet that prevents all modification operations.

This class:

  • Wraps an existing CollectiveSet to make it immutable
  • Optionally makes elements unmodifiable if they're Cell objects
  • Maintains all reactive relationships
  • Throws UnsupportedError on modification attempts

Usage Examples:

// Create from existing set
final mutableSet = CollectiveSet({1, 2, 3});
final immutableSet = UnmodifiableCollectiveSet.bind(mutableSet);

// Create directly
final direct = UnmodifiableCollectiveSet({4, 5, 6});

See also:

Inheritance
Implemented types
Mixed-in types
Available extensions

Constructors

UnmodifiableCollectiveSet(Iterable<E> elements, {bool unmodifiableElement = true, CollectiveSetProperties<E>? properties})
Creates an unmodifiable set with initial elements.
UnmodifiableCollectiveSet.bind(Collective bind, {bool unmodifiableElement = true, CollectiveSetProperties<E>? properties, Iterable<E>? elements})
Creates an unmodifiable wrapper around an existing CollectiveSet.
UnmodifiableCollectiveSet.fromProperties(CollectiveProperties<E> properties, {bool unmodifiableElement = true, Iterable<E>? elements})
Creates from properties with optional elements.

Properties

async → CollectiveSetAsync<E>
Creates an async version of this unmodifiable set.
no setteroverride
first → E
The first element.
no setterinherited
firstOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The first element of this iterator, or null if the iterable is empty.
no setter
hashCode → int
The hash code for this object.
no setterinherited
indexed → Iterable<(int, T)>

Available on Iterable<T>, provided by the IterableExtensions extension

Pairs of elements of the indices and elements of this iterable.
no setter
isEmpty → bool
Whether this collection has no elements.
no setterinherited
isNotEmpty → bool
Whether this collection has at least one element.
no setterinherited
iterator → Iterator<E>
An iterator that iterates over the elements of this set.
no setterinherited
last → E
The last element.
no setterinherited
lastOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The last element of this iterable, or null if the iterable is empty.
no setter
length → int
The number of elements in this Iterable.
no setterinherited
modifiable → Iterable<Function>
Returns an iterable containing modifiable functions.
no setterinherited
nonNulls → Iterable<T>

Available on Iterable<T?>, provided by the NullableIterableExtensions extension

The non-null elements of this iterable.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → E
Checks that this iterable has only one element, and returns that element.
no setterinherited
singleOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The single element of this iterator, or null.
no setter
test → TestCollective<dynamic, Collective>
Gets the test object associated with the cell.
no setterinherited
unmodifiable → CollectiveSet<E>
Returns this unmodifiable instance (no-op).
no setteroverride
wait → Future<List<T>>

Available on Iterable<Future<T>>, provided by the FutureIterable extension

Waits for futures in parallel.
no setter

Methods

add(E element) → bool
Adds value to the set.
inherited
addAll(Iterable<E> elements) → Object?
Adds all elements from the iterable to the set
inheritedoverride
any(bool test(E element)) → bool
Checks whether any element of this iterable satisfies test.
inherited
apply(Function function, List? positionalArguments, [Map<Symbol, dynamic>? namedArguments]) → dynamic
Applies a function with controlled validation.
inherited
asNameMap() → Map<String, T>

Available on Iterable<T>, provided by the EnumByName extension

Creates a map from the names of enum values to the values.
byName(String name) → T

Available on Iterable<T>, provided by the EnumByName extension

Finds the enum value in this list with name name.
cast<R>() → Set<R>
Provides a view of this set as a set of R instances.
inherited
clear() → Object?
Clears the set, removing all elements
inheritedoverride
contains(Object? element) → bool
Whether the collection contains an element equal to element.
inherited
containsAll(Iterable<Object?> other) → bool
Whether this set contains all the elements of other.
inherited
deputy({covariant TestCollective<dynamic, Collective>? test, covariant MapObject? mapObject}) → CollectiveSet<E>
Creates an unmodifiable deputy for this set.
override
difference(Set<Object?> other) → Set<E>
Creates a new set with the elements of this that are not in other.
inherited
elementAt(int index) → E
Returns the indexth element.
inherited
elementAtOrNull(int index) → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The element at position index of this iterable, or null.
every(bool f(E element)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> f(E element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(E value), {E orElse()?}) → E
The first element that satisfies the given predicate test.
inherited
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
inherited
followedBy(Iterable<E> other) → Iterable<E>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void f(E element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
intersection(Set<Object?> other) → Set<E>
Creates a new set which is the intersection between this set and other.
inherited
join([String separator = ""]) → String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(E value), {E orElse()?}) → E
The last element that satisfies the given predicate test.
inherited
lookup(Object? element) → E?
If an object equal to object is in the set, return it.
inherited
map<T>(T f(E element)) → Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
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.
inherited
remove(Object? object) → bool
Removes value from the set.
inherited
removeAll(Iterable<Object?> elements) → Object?
Removes all elements in the iterable from the set
inheritedoverride
removeWhere(bool test(E element)) → Object?
Removes all elements in the iterable from the set
inheritedoverride
retainAll(Iterable<Object?> elements) → Object?
Retains only the elements in the iterable
inheritedoverride
retainWhere(bool test(E element)) → Object?
Retains only the elements that satisfy the test
inheritedoverride
singleWhere(bool test(E value), {E orElse()?}) → E
The single element that satisfies test.
inherited
skip(int n) → Iterable<E>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(E value)) → Iterable<E>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int n) → Iterable<E>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(E value)) → Iterable<E>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) → List<E>
Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<E>
Creates a Set containing the same elements as this iterable.
inherited
toString() → String
A string representation of this object.
inherited
union(Set<E> other) → Set<E>
Creates a new set which contains all the elements of this set and other.
inherited
where(bool f(E element)) → Iterable<E>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() → Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

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

Static Methods

create<E, I extends Set<E>>({Iterable<E>? elements, bool unmodifiableElement = true, Cell? bind, ContainerType? container, CollectiveReceptor<dynamic, Signal, Signal> receptor = CollectiveReceptor.unchanged, TestCollective<dynamic, Collective> test = TestCollective.passed, MapObject? mapObject, Synapses<Signal, Cell> synapses = Synapses.enabled}) → CollectiveSet<E>
Factory constructor for full configuration.
override