UnmodifiableCollectiveQueue<E> class

An unmodifiable version of a CollectiveQueue that implements the Queue interface.

This class wraps a CollectiveQueue and prevents all modification operations, throwing UnsupportedError when modification methods are called. It maintains all the read-only functionality of a queue while preventing changes to its contents.

The queue can be created as unmodifiable from the start, or can be created by wrapping an existing CollectiveQueue using the bind constructor.

Example:

final queue = CollectiveQueue.of([1, 2, 3]);
final unmodifiableQueue = UnmodifiableCollectiveQueue.bind(queue);

Type parameters:

E: The type of elements in the queue

Inheritance

Object
CellBase
CollectiveCell<E>
UnmodifiableCollectiveCell<E>
UnmodifiableCollectiveQueue

Implemented types

CollectiveQueue<E>

Mixed-in types

IterableMixin<E>
OpenQueueMixin<E>

Available extensions

Constructors

UnmodifiableCollectiveQueue.new(Iterable<E> elements, {bool unmodifiableElement = true, CollectiveQueueProperties<E>? properties}): Creates an unmodifiable queue containing the given elements.
UnmodifiableCollectiveQueue.bind(Collective bind, {bool unmodifiableElement = true, CollectiveQueueProperties<E>? properties, Iterable<E>? elements}): Creates an unmodifiable queue by binding to an existing Collective.
UnmodifiableCollectiveQueue.fromProperties(CollectiveProperties<E> properties, {bool unmodifiableElement = true, Iterable<E>? elements}): Creates an unmodifiable queue from existing properties.

Properties

async → CollectiveQueueAsync<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 setterinherited
unmodifiable → CollectiveQueue<E>: Creates an unmodifiable view of this cell.
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 value) → void: Adds value at the end of the queue.
inherited
addAll(Iterable<E> iterable) → void: Adds all elements of iterable at the end of the queue. The length of the queue is extended by the length of iterable.
inherited
addFirst(E value) → void: Adds value at the beginning of the queue.
inherited
addLast(E value) → void: Adds value at the end of the queue.
inherited
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>() → Queue<R>: A view of this iterable as an iterable of R instances.
override
clear() → void: Removes all elements in the queue. The size of the queue becomes zero.
inherited
contains(Object? element) → bool: Whether the collection contains an element equal to element.
inherited
deputy({covariant TestCollective<dynamic, Collective>? test, covariant MapObject? mapObject}) → CollectiveQueue<E>: Creates an deputy (helper) for this unmodifiable queue with optional test and map configurations.
override
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
remove(Object? object) → bool: Removes a single instance of value from the queue.
inherited
removeFirst() → E: Removes and returns the first element of this queue.
inherited
removeLast() → E: Removes and returns the last element of the queue.
inherited
removeWhere(bool test(E element)) → void: Removes all elements matched by test from the queue.
inherited
retainWhere(bool test(E element)) → void: Removes all elements not matched by test from the queue.
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: Returns a string representation of (some of) the elements of this.
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 Queue<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}) → CollectiveQueue<E>: Factory constructor to create an unmodifiable queue with configuration options.
override