Set

add

abstract fun add(element: E): Boolean

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

addAll

abstract fun addAll(elements: Collection<E>): Boolean

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

clear

abstract fun clear(): Unit

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

contains

abstract fun contains(element: E?): Boolean

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

containsAll

abstract fun containsAll(elements: Collection<E>): Boolean

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

copyOf

open static fun <E : Any!> copyOf(coll: MutableCollection<out E>): MutableSet<E>

Returns an unmodifiable Set containing the elements of the given Collection. The given Collection must not be null, and it must not contain any null elements. If the given Collection contains duplicate elements, an arbitrary element of the duplicates is preserved. If the given Collection is subsequently modified, the returned Set will not reflect such modifications.

isEmpty

abstract fun isEmpty(): Boolean

Returns true if this set contains no elements.

iterator

abstract fun iterator(): MutableIterator<E>

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

of

open static fun <E : Any!> of(): MutableSet<E>

Returns an unmodifiable set containing zero elements. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(e1: E): MutableSet<E>

Returns an unmodifiable set containing one element. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(
    e1: E, 
    e2: E
): MutableSet<E>

Returns an unmodifiable set containing two elements. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(
    e1: E, 
    e2: E, 
    e3: E
): MutableSet<E>

Returns an unmodifiable set containing three elements. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(
    e1: E, 
    e2: E, 
    e3: E, 
    e4: E
): MutableSet<E>

Returns an unmodifiable set containing four elements. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(
    e1: E, 
    e2: E, 
    e3: E, 
    e4: E, 
    e5: E
): MutableSet<E>

Returns an unmodifiable set containing five elements. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(
    e1: E, 
    e2: E, 
    e3: E, 
    e4: E, 
    e5: E, 
    e6: E
): MutableSet<E>

Returns an unmodifiable set containing six elements. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(
    e1: E, 
    e2: E, 
    e3: E, 
    e4: E, 
    e5: E, 
    e6: E, 
    e7: E
): MutableSet<E>

Returns an unmodifiable set containing seven elements. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(
    e1: E, 
    e2: E, 
    e3: E, 
    e4: E, 
    e5: E, 
    e6: E, 
    e7: E, 
    e8: E
): MutableSet<E>

Returns an unmodifiable set containing eight elements. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(
    e1: E, 
    e2: E, 
    e3: E, 
    e4: E, 
    e5: E, 
    e6: E, 
    e7: E, 
    e8: E, 
    e9: E
): MutableSet<E>

Returns an unmodifiable set containing nine elements. See Unmodifiable Sets for details.

of

open static fun <E : Any!> of(
    e1: E, 
    e2: E, 
    e3: E, 
    e4: E, 
    e5: E, 
    e6: E, 
    e7: E, 
    e8: E, 
    e9: E, 
    e10: E
): MutableSet<E>

Returns an unmodifiable set containing ten elements. See Unmodifiable Sets for details.

of

@SafeVarargs open static fun <E : Any!> of(vararg elements: E): MutableSet<E>

Returns an unmodifiable set containing an arbitrary number of elements. See Unmodifiable Sets for details.

remove

abstract fun remove(element: E?): Boolean

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

removeAll

abstract fun removeAll(elements: Collection<E>): Boolean

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

retainAll

abstract fun retainAll(elements: Collection<E>): Boolean

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

spliterator

open fun spliterator(): Spliterator<E>

Creates a Spliterator over the elements in this set.

The Spliterator reports Spliterator.DISTINCT. Implementations should document the reporting of additional characteristic values.

toArray

abstract fun toArray(): Array<Any!>

Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

toArray

abstract fun <T : Any!> toArray(a: Array<T>): Array<T>

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to null. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.)

If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of String:

String[] y = x.toArray(new String[0]);

size

abstract val size: Int

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.