Added in API level 1

AbstractSet

abstract class AbstractSet<E : Any!> : AbstractCollection<E>, MutableSet<E>

kotlin.Any
↳	java.util.AbstractCollection<E>
	↳	java.util.AbstractSet

Known Direct Subclasses ConcurrentSkipListSet, CopyOnWriteArraySet, EnumSet, HashSet, TreeSet ConcurrentSkipListSet A scalable concurrent NavigableSet implementation based on a ConcurrentSkipListMap. CopyOnWriteArraySet A Set that uses an internal CopyOnWriteArrayList for all of its operations. EnumSet A specialized Set implementation for use with enum types. HashSet This class implements the Set interface, backed by a hash table (actually a HashMap instance). TreeSet A NavigableSet implementation based on a TreeMap.

Known Indirect Subclasses LinkedHashSet LinkedHashSet Hash table and linked list implementation of the Set interface, with well-defined encounter order.

This class provides a skeletal implementation of the Set interface to minimize the effort required to implement this interface.

The process of implementing a set by extending this class is identical to that of implementing a Collection by extending AbstractCollection, except that all of the methods and constructors in subclasses of this class must obey the additional constraints imposed by the Set interface (for instance, the add method must not permit addition of multiple instances of an object to a set).

Note that this class does not override any of the implementations from the AbstractCollection class. It merely adds implementations for equals and hashCode.

This class is a member of the Java Collections Framework.

Summary

Protected constructors
AbstractSet() Sole constructor.

Public methods
open Boolean	equals(other: Any?) Compares the specified object with this set for equality.
open Int	hashCode() Returns the hash code value for this set.
open Boolean	removeAll(elements: Collection<E>) Removes from this set all of its elements that are contained in the specified collection (optional operation).

Inherited functions

From class AbstractCollection Boolean add(element: E) Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.) Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added. If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns. Boolean addAll(elements: Collection<E>) Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.) If the specified collection has a defined encounter order, processing of its elements generally occurs in that order. Unit clear() Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns. Boolean contains(element: E?) Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that Objects.equals(o, e). Boolean containsAll(elements: Collection<E>) Returns true if this collection contains all of the elements in the specified collection. Boolean isEmpty() Returns true if this collection contains no elements. MutableIterator<E> iterator() Returns an iterator over the elements contained in this collection. Boolean remove(element: E?) Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call). Boolean retainAll(elements: Collection<E>) Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection. Array<Any!> toArray() Returns an array containing all of the elements in this collection. If this collection 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's runtime component type is Object. The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array. Array<T> toArray(a: Array<T>) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection 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 collection. If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.) If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. String toString() Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).

Inherited properties
From class AbstractCollection Int size

Protected constructors

AbstractSet

Added in API level 1

protected AbstractSet()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Public methods

equals

Added in API level 1

open fun equals(other: Any?): Boolean

Compares the specified object with this set for equality. Returns true if the given object is also a set, the two sets have the same size, and every member of the given set is contained in this set. This ensures that the equals method works properly across different implementations of the Set interface.

This implementation first checks if the specified object is this set; if so it returns true. Then, it checks if the specified object is a set whose size is identical to the size of this set; if not, it returns false. If so, it returns containsAll((Collection) o).

Parameters
obj	the reference object with which to compare.
o	object to be compared for equality with this set

Return
Boolean	true if the specified object is equal to this set

hashCode

Added in API level 1

open fun hashCode(): Int

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object.hashCode.

This implementation iterates over the set, calling the hashCode method on each element in the set, and adding up the results.

Return
Int	the hash code value for this set

See Also

• java.lang.Object#equals(Object)

removeAll

Added in API level 1

open 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.

This implementation determines which is the smaller of this set and the specified collection, by invoking the size method on each. If this set has fewer elements, then the implementation iterates over this set, checking each element returned by the iterator in turn to see if it is contained in the specified collection. If it is so contained, it is removed from this set with the iterator's remove method. If the specified collection has fewer elements, then the implementation iterates over the specified collection, removing from this set each element returned by the iterator, using this set's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method.

Parameters
c	collection containing elements to be removed from this set

Return
Boolean	true if this set changed as a result of the call

Exceptions
java.lang.UnsupportedOperationException	if the removeAll operation is not supported by this set
java.lang.ClassCastException	if the class of an element of this set is incompatible with the specified collection (optional)
java.lang.NullPointerException	if this set contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null

See Also