Collective<E> class abstract interface

A reactive collection that combines Cell behavior with Iterable functionality. Notifies about changes (add/remove/update) and maintains relationships between cells.

It provides:

Reactive collection types (List, Set, Value) that integrate with Cell system
Comprehensive change notification system
Flexible validation framework
Relationship management between cells
Immutable variants for safe sharing
Customizable container behaviors

The architecture allows building complex reactive data flows while maintaining type safety and clear separation of concerns. Collections can be composed and chained to create sophisticated data processing pipelines.

Events:

elementAdded: When an element is added
elementRemoved: When an element is removed
elementUpdated: When an element is updated

Example:


// Create a reactive list
final list = Collective<int>([1, 2, 3]);

// Listen for changes
Cell.listen<CollectivePost>(
  bind: list,
  listen: (post, _) {
    if (post.body!.containsKey(Collective.elementAdded)) {
      print('Added: ${post.body![Collective.elementAdded]}');
    }
  }
);

// Modify the list
list.add(4); // Will trigger listener

Example:

// Example:
final safeList = CollectiveList<int>(
  [],
  test: TestCollective.create(
    elementDisallow: (num, _) => num < 0, // No negatives
    actionDisallow: (_) => [List.clear], // Don't allow clear
    maxLength: 100
  )
);

Implemented types

Cell
Iterable<E>

Implementers

Available extensions

Constructors

Collective.new(Iterable<E> elements, {Cell? bind, TestCollective<dynamic, Collective> test = TestCollective.passed}): Creates a collective from elements
factory
Collective.empty({Cell? bind, TestCollective<dynamic, Collective> test = TestCollective.passed}): Creates an empty collective
factory
Collective.fromProperties(CollectiveProperties<E> properties, {Iterable<E>? elements}): Creates a collective from properties
factory
Collective.unmodifiable(Collective<E> bind, {bool unmodifiableElement = true}): Creates an unmodifiable view
factory

Properties

async → CollectiveAsync<E, Collective<E>>: Creates an async variant for modifiable operations
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>: A new Iterator that allows iterating the elements of this Iterable.
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 setteroverride
unmodifiable → Cell: Creates an unmodifiable view of this cell.
no setterinherited
wait → Future<List<T>>: Available on Iterable<Future<T>>, provided by the FutureIterable extension
Waits for futures in parallel.
no setter

Methods

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>() → Iterable<R>: A view of this iterable as an iterable of R instances.
inherited
contains(Object? element) → bool: Whether the collection contains an element equal to element.
inherited
deputy({covariant TestObject<Cell>? test, covariant MapObject? mapObject}) → Cell: Creates an Deputy cell from an existing Cell instance with reduced permissions.
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 test(E element)) → bool: Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(E element)) → Iterable<T>: Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(E element), {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 action(E element)) → void: Invokes action on each element of this iterable in iteration order.
inherited
join([String separator = ""]) → String: Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(E element), {E orElse()?}) → E: The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(E e)) → 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
singleWhere(bool test(E element), {E orElse()?}) → E: The single element that satisfies test.
inherited
skip(int count) → 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 count) → 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
where(bool test(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 Iterable<E>>({Iterable<E>? elements, 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}) → Collective<E>: Creates a collective with properties

Constants

elementAdded → const CollectiveEvent: Event identifier for when an element is added to a Collective.
elementRemoved → const CollectiveEvent: Event identifier for when an element is removed from a Collective.
elementUpdated → const CollectiveEvent: Event identifier for when an element's value is updated in a Collective.