MutableOrderedScatterSet

Artifact: androidx.collection:collection

Kotlin |Java

Cmn

class MutableOrderedScatterSet<E : Any?> : OrderedScatterSet

kotlin.Any
↳	androidx.collection.OrderedScatterSet
	↳	androidx.collection.MutableOrderedScatterSet

MutableOrderedScatterSet is a container with a MutableSet-like interface based on a flat hash table implementation that preserves the insertion order for iteration. The underlying implementation is designed to avoid all allocations on insertion, removal, retrieval, and iteration. Allocations may still happen on insertion when the underlying storage needs to grow to accommodate newly added elements to the set.

This implementation guarantees the order of the elements when iterating over them using forEach or the iterator provided by asMutableSet.

This implementation is not thread-safe: if multiple threads access this container concurrently, and one or more threads modify the structure of the set (insertion or removal for instance), the calling code must provide the appropriate synchronization. Concurrent reads are however safe.

Note: when a Set is absolutely necessary, you can use the method asSet to create a thin wrapper around a MutableOrderedScatterSet. Please refer to asSet for more details and caveats.

Note: when a MutableSet is absolutely necessary, you can use the method asMutableSet to create a thin wrapper around a MutableOrderedScatterSet. Please refer to asMutableSet for more details and caveats.

See also
`Set`

Summary

Public constructors
`<E : Any?> MutableOrderedScatterSet(initialCapacity: Int)` Creates a new `MutableOrderedScatterSet`	Cmn

Public functions
`Boolean`	`add(element: E)` Adds the specified element to the set.	Cmn
`Boolean`	`addAll(elements: Array<E>)` Adds all the `elements` into this set.	Cmn
`Boolean`	`addAll(elements: Iterable<E>)` Adds all the `elements` into this set.	Cmn
`Boolean`	`addAll(elements: ObjectList<E>)` Adds all the elements in the `elements` set into this set.	Cmn
`Boolean`	`addAll(elements: OrderedScatterSet<E>)` Adds all the elements in the `elements` set into this set.	Cmn
`Boolean`	`addAll(elements: ScatterSet<E>)` Adds all the elements in the `elements` set into this set.	Cmn
`Boolean`	`addAll(elements: Sequence<E>)` Adds all the `elements` into this set.	Cmn
`MutableSet<E>`	`asMutableSet()` Wraps this `OrderedScatterSet` with a `MutableSet` interface.	Cmn
`Unit`	`clear()` Removes all elements from this set.	Cmn
`operator Unit`	`minusAssign(element: E)` Removes the specified `element` from the set if it is present.	Cmn
`operator Unit`	`minusAssign(elements: Array<E>)` Removes the specified `elements` from the set, if present.	Cmn
`operator Unit`	`minusAssign(elements: Iterable<E>)` Removes the specified `elements` from the set, if present.	Cmn
`operator Unit`	`minusAssign(elements: ObjectList<E>)` Removes the specified `elements` from the set, if present.	Cmn
`operator Unit`	`minusAssign(elements: OrderedScatterSet<E>)` Removes the specified `elements` from the set, if present.	Cmn
`operator Unit`	`minusAssign(elements: ScatterSet<E>)` Removes the specified `elements` from the set, if present.	Cmn
`operator Unit`	`minusAssign(elements: Sequence<E>)` Removes the specified `elements` from the set, if present.	Cmn
`operator Unit`	`plusAssign(element: E)` Adds the specified element to the set.	Cmn
`operator Unit`	`plusAssign(elements: Array<E>)` Adds all the `elements` into this set.	Cmn
`operator Unit`	`plusAssign(elements: Iterable<E>)` Adds all the `elements` into this set.	Cmn
`operator Unit`	`plusAssign(elements: ObjectList<E>)` Adds all the elements in the `elements` set into this set.	Cmn
`operator Unit`	`plusAssign(elements: OrderedScatterSet<E>)` Adds all the elements in the `elements` set into this set.	Cmn
`operator Unit`	`plusAssign(elements: ScatterSet<E>)` Adds all the elements in the `elements` set into this set.	Cmn
`operator Unit`	`plusAssign(elements: Sequence<E>)` Adds all the `elements` into this set.	Cmn
`Boolean`	`remove(element: E)` Removes the specified `element` from the set.	Cmn
`Boolean`	`removeAll(elements: Array<E>)` Removes the specified `elements` from the set, if present.	Cmn
`Boolean`	`removeAll(elements: Iterable<E>)` Removes the specified `elements` from the set, if present.	Cmn
`Boolean`	`removeAll(elements: ObjectList<E>)` Removes the specified `elements` from the set, if present.	Cmn
`Boolean`	`removeAll(elements: OrderedScatterSet<E>)` Removes the specified `elements` from the set, if present.	Cmn
`Boolean`	`removeAll(elements: ScatterSet<E>)` Removes the specified `elements` from the set, if present.	Cmn
`Boolean`	`removeAll(elements: Sequence<E>)` Removes the specified `elements` from the set, if present.	Cmn
`inline Unit`	`removeIf(predicate: (E) -> Boolean)` Removes any values for which the specified `predicate` returns true.	Cmn
`Boolean`	`retainAll(elements: Collection<E>)` Removes all the entries in this set that are not contained in `elements`.	Cmn
`Boolean`	`retainAll(elements: OrderedScatterSet<E>)` Removes all the entries in this set that are not contained in `elements`.	Cmn
`Boolean`	`retainAll(elements: ScatterSet<E>)` Removes all the entries in this set that are not contained in `elements`.	Cmn
`inline Boolean`	`retainAll(predicate: (E) -> Boolean)` Removes all the elements in this set for which the specified `predicate` is `true`.	Cmn
`@IntRange(from = 0) Int`	`trim()` Trims this `MutableOrderedScatterSet`'s storage so it is sized appropriately to hold the current elements.	Cmn
`Unit`	`trimToSize(maxSize: Int)` Remove entries until the total size of the remaining entries is less than or equal to `maxSize`.	Cmn

Inherited functions

From androidx.collection.OrderedScatterSet

`inline Boolean`	`all(predicate: (element) -> Boolean)` Returns true if all elements match the given `predicate`.	Cmn
`Boolean`	`any()` Returns `true` if this set has at least one element.	Cmn
`inline Boolean`	`any(predicate: (element) -> Boolean)` Returns true if at least one element matches the given `predicate`.	Cmn
`Set<E>`	`asSet()` Wraps this `OrderedScatterSet` with a `Set` interface.	Cmn
`operator Boolean`	`contains(element: E)` Returns true if the specified `element` is present in this hash set, false otherwise.	Cmn
`@IntRange(from = 0) Int`	`count()` Returns the number of elements in this set.	Cmn
`inline @IntRange(from = 0) Int`	`count(predicate: (element) -> Boolean)` Returns the number of elements matching the given `predicate`.The order in which the predicate is called over the elements is arbitrary.	Cmn
`open operator Boolean`	`equals(other: Any?)` Compares the specified object `other` with this hash set for equality.	Cmn
`E`	`first()` Returns the first element in the collection.	Cmn
`inline E`	`first(predicate: (element) -> Boolean)` Returns the first element in insertion order in the collection for which `predicate` returns `true`.	Cmn
`inline E?`	`firstOrNull(predicate: (element) -> Boolean)` Returns the first element in insertion order in the collection for which `predicate` returns `true` or `null` if there are no elements that match `predicate`.	Cmn
`inline Unit`	`forEach(block: (element) -> Unit)` Iterates over every element stored in this set by invoking the specified `block` lambda.	Cmn
`inline Unit`	`forEachReverse(block: (element) -> Unit)` Iterates over every element stored in this set by invoking the specified `block` lambda.	Cmn
`open Int`	`hashCode()` Returns the hash code value for this set.	Cmn
`Boolean`	`isEmpty()` Indicates whether this set is empty.	Cmn
`Boolean`	`isNotEmpty()` Returns `true` if this set is not empty.	Cmn
`String`	`joinToString( separator: CharSequence, prefix: CharSequence, postfix: CharSequence, limit: Int, truncated: CharSequence, transform: ((E) -> CharSequence)? )` Creates a String from the elements separated by `separator` and using `prefix` before and `postfix` after, if supplied.	Cmn
`E`	`last()` Returns the last element in the collection.	Cmn
`inline E`	`last(predicate: (element) -> Boolean)` Returns the last element in insertion order in the collection for which `predicate` returns `true`.	Cmn
`inline E?`	`lastOrNull(predicate: (element) -> Boolean)` Returns the first element in insertion order in the collection for which `predicate` returns `true` or `null` if there are no elements that match `predicate`.	Cmn
`Boolean`	`none()` Returns `true` if this set has no elements.	Cmn
`inline List<E>`	`toList()` Returns a new list containing this set's entries, in insertion order.	Cmn
`open String`	`toString()` Returns a string representation of this set.	Cmn

Inherited properties

From androidx.collection.OrderedScatterSet

`Int`	`capacity` Returns the number of elements that can be stored in this set without requiring internal storage reallocation.	Cmn
`Int`	`size` Returns the number of elements in this set.	Cmn

Public constructors