ArraySet

Artifact: androidx.collection:collection

Added in 1.0.0

Kotlin |Java

public final class ArraySet<E extends Object> implements MutableCollection, MutableSet

ArraySet is a generic set data structure that is designed to be more memory efficient than a traditional HashSet. The design is very similar to ArrayMap, with all of the caveats described there. This implementation is separate from ArrayMap, however, so the Object array contains only one item for each entry in the set (instead of a pair for a mapping).

Note that this implementation is not intended to be appropriate for data structures that may contain large numbers of items. It is generally slower than a traditional HashSet, since lookups require a binary search and adds and removes require inserting and deleting entries in the array. For containers holding up to hundreds of items, the performance difference is not significant, less than 50%.

Because this container is intended to better balance memory use, unlike most other standard Java containers it will shrink its array as items are removed from it. Currently you have no control over this shrinking -- if you set a capacity and then remove an item, it may reduce the capacity to better match the current size. In the future an explicit call to set the capacity should turn off this aggressive shrinking behavior.

This structure is NOT thread-safe.

Summary

Public constructors
`<E extends Object> ArraySet(E[] array)` Create a new ArraySet with items from the given array.
`<E extends Object> ArraySet(int capacity)` Creates a new empty ArraySet.
`<E extends Object> ArraySet(ArraySet<@NonNull E> set)` Create a new ArraySet with the mappings from the given ArraySet.
`<E extends Object> ArraySet(Collection<@NonNull E> set)` Create a new ArraySet with the mappings from the given `Collection`.

Public methods
`boolean`	`add(@NonNull E element)` Adds the specified object to this set.
`final void`	`addAll(@NonNull ArraySet<@NonNull E> array)` Perform a `add` of all values in `array`
`boolean`	`addAll(@NonNull Collection<@NonNull E> elements)` Perform an `add` of all values in `elements`
`void`	`clear()` Make the array map empty.
`boolean`	`contains(@NonNull E element)` Check whether a value exists in the set.
`boolean`	`containsAll(@NonNull Collection<@NonNull E> elements)` Determine if the array set contains all of the values in the given collection.
`final void`	`ensureCapacity(int minimumCapacity)` Ensure the array map can hold at least `minimumCapacity` items.
`boolean`	`equals(Object other)` This implementation returns false if the object is not a set, or if the sets have different sizes.
`int`	`getSize()`
`int`	`hashCode()`
`final int`	`indexOf(Object key)` Returns the index of a value in the set.
`boolean`	`isEmpty()` Return `true` if the array map contains no items.
`@NonNull Iterator<@NonNull E>`	`iterator()` Return a `MutableIterator` over all values in the set.
`boolean`	`remove(@NonNull E element)` Removes the specified object from this set.
`final boolean`	`removeAll(@NonNull ArraySet<@NonNull E> array)` Perform a `remove` of all values in `array`
`boolean`	`removeAll(@NonNull Collection<@NonNull E> elements)` Remove all values in the array set that exist in the given collection.
`final @NonNull E`	`removeAt(int index)` Remove the key/value mapping at the given index.
`boolean`	`retainAll(@NonNull Collection<@NonNull E> elements)` Remove all values in the array set that do not exist in the given collection.
`final @NonNull Object[]`	`toArray()`
`final @NonNull T[]`	`<T extends Object> toArray(@NonNull T[] array)`
`@NonNull String`	`toString()` This implementation composes a string by iterating over its values.
`final @NonNull E`	`valueAt(int index)` Return the value at the given index in the array.

Inherited methods

From kotlin.collections.Collection

`@NonNull Stream<@NonNull E>`	`@RecentlyNonNull parallelStream()`
`@NonNull Spliterator<@NonNull E>`	`@RecentlyNonNull spliterator()`
`@NonNull Stream<@NonNull E>`	`@RecentlyNonNull stream()`
`@NonNull T[]`	`@RecentlyNonNull <T extends Object> toArray(@RecentlyNonNull @NonNull IntFunction<@NonNull T[]> p0)` This method is deprecated. This member is not fully supported by Kotlin compiler, so it may be absent or have different signature in next major version

From kotlin.collections.Iterable

void

forEach(@RecentlyNonNull @NonNull Consumer<@NonNull E> p0)

From kotlin.collections.MutableCollection

boolean

removeIf(@RecentlyNonNull @NonNull Predicate<@NonNull E> p0)

Public constructors

ArraySet

public <E extends Object> ArraySet(E[] array)

Create a new ArraySet with items from the given array.

ArraySet

public <E extends Object> ArraySet(int capacity)

Creates a new empty ArraySet. The default capacity of an array map is 0, and will grow once items are added to it.

ArraySet

public <E extends Object> ArraySet(ArraySet<@NonNull E> set)

Create a new ArraySet with the mappings from the given ArraySet.

ArraySet

public <E extends Object> ArraySet(Collection<@NonNull E> set)

Create a new ArraySet with the mappings from the given Collection.

Public methods

add

Added in 1.0.0

public boolean add(@NonNull E element)

Adds the specified object to this set. The set is not modified if it already contains the object.

Parameters
`@NonNull E element`	the object to add.

Returns
`boolean`	`true` if this set is modified, `false` otherwise.

Throws
`kotlin.ConcurrentModificationException`	if concurrent modifications detected.

addAll

Added in 1.0.0

public final void addAll(@NonNull ArraySet<@NonNull E> array)

Perform a add of all values in array

Parameters
`@NonNull ArraySet<@NonNull E> array`	The array whose contents are to be retrieved.

Throws
`kotlin.ConcurrentModificationException`	if concurrent modifications detected.

addAll

public boolean addAll(@NonNull Collection<@NonNull E> elements)

Perform an add of all values in elements

Parameters
`@NonNull Collection<@NonNull E> elements`	The collection whose contents are to be retrieved.

clear

Added in 1.0.0

public void clear()

Make the array map empty. All storage is released.

Throws
`kotlin.ConcurrentModificationException`	if concurrent modifications detected.

contains

Added in 1.3.0

public boolean contains(@NonNull E element)

Check whether a value exists in the set.

Parameters
`@NonNull E element`	The value to search for.

Returns
`boolean`	Returns true if the value exists, else false.

containsAll

Added in 1.3.0

public boolean containsAll(@NonNull Collection<@NonNull E> elements)

Determine if the array set contains all of the values in the given collection.

Parameters
`@NonNull Collection<@NonNull E> elements`	The collection whose contents are to be checked against.

Returns
`boolean`	Returns true if this array set contains a value for every entry in `elements` else returns false.

ensureCapacity

Added in 1.0.0

public final void ensureCapacity(int minimumCapacity)

Ensure the array map can hold at least minimumCapacity items.

Throws
`kotlin.ConcurrentModificationException`	if concurrent modifications detected.

equals

public boolean equals(Object other)

This implementation returns false if the object is not a set, or if the sets have different sizes. Otherwise, for each value in this set, it checks to make sure the value also exists in the other set. If any value doesn't exist, the method returns false; otherwise, it returns true.

See also
`equals`

getSize

Added in 1.3.0

public int getSize()

hashCode

public int hashCode()

See also
`hashCode`

indexOf

Added in 1.0.0

public final int indexOf(Object key)

Returns the index of a value in the set.

Parameters
`Object key`	The value to search for.

Returns
`int`	Returns the index of the value if it exists, else a negative integer.

isEmpty

Added in 1.0.0

public boolean isEmpty()

Return true if the array map contains no items.

iterator

Added in 1.0.0

public @NonNull Iterator<@NonNull E> iterator()

Return a MutableIterator over all values in the set.

Note: this is a less efficient way to access the array contents compared to looping from 0 until size and calling valueAt.

remove

Added in 1.3.0

public boolean remove(@NonNull E element)

Removes the specified object from this set.

Parameters
`@NonNull E element`	the object to remove.

Returns
`boolean`	`true` if this set was modified, `false` otherwise.

removeAll

Added in 1.0.0

public final boolean removeAll(@NonNull ArraySet<@NonNull E> array)

Perform a remove of all values in array

Parameters
`@NonNull ArraySet<@NonNull E> array`	The array whose contents are to be removed.

removeAll

Added in 1.3.0

public boolean removeAll(@NonNull Collection<@NonNull E> elements)

Remove all values in the array set that exist in the given collection.

Parameters
`@NonNull Collection<@NonNull E> elements`	The collection whose contents are to be used to remove values.

Returns
`boolean`	Returns true if any values were removed from the array set, else false.

removeAt

Added in 1.0.0

public final @NonNull E removeAt(int index)

Remove the key/value mapping at the given index.

Parameters
`int index`	The desired index, must be between 0 and `size`-1.

Returns
`@NonNull E`	Returns the value that was stored at this index.

Throws
`kotlin.ConcurrentModificationException`	if concurrent modifications detected.

retainAll

Added in 1.3.0

public boolean retainAll(@NonNull Collection<@NonNull E> elements)

Remove all values in the array set that do not exist in the given collection.

Parameters
`@NonNull Collection<@NonNull E> elements`	The collection whose contents are to be used to determine which values to keep.

Returns
`boolean`	Returns true if any values were removed from the array set, else false.

toArray

Added in 1.0.0

public final @NonNull Object[] toArray()

toArray

Added in 1.0.0

public final @NonNull T[] <T extends Object> toArray(@NonNull T[] array)

toString

public @NonNull String toString()

This implementation composes a string by iterating over its values. If this set contains itself as a value, the string "(this Set)" will appear in its place.

valueAt

Added in 1.0.0

public final @NonNull E valueAt(int index)

Return the value at the given index in the array.

Parameters
`int index`	The desired index, must be between 0 and `size`-1.

Returns
`@NonNull E`	Returns the value stored at the given index.