OrderedScatterSet

Artifact: androidx.collection:collection

Kotlin |Java

Cmn

sealed class OrderedScatterSet<E : Any?>

Known direct subclasses

MutableOrderedScatterSet

MutableOrderedScatterSet

MutableOrderedScatterSet is a container with a MutableSet-like interface based on a flat hash table implementation that preserves the insertion order for iteration.

OrderedScatterSet is a container with a Set-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 asSet.

Though OrderedScatterSet offers a read-only interface, it is always backed by a MutableOrderedScatterSet. Read operations alone are thread-safe. However, any mutations done through the backing MutableScatterSet while reading on another thread are not safe and the developer must protect the set from such changes during read operations.

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

See also
`MutableOrderedScatterSet`

Summary

Protected constructors
`<E : Any?> OrderedScatterSet()`	Cmn

Public functions
`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

Public properties
`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

Protected constructors