Set (Java SE 9 & JDK 9 ) (original) (raw)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods

Modifier and Type	Method	Description
boolean	add(E e)	Adds the specified element to this set if it is not already present (optional operation).
boolean	addAll(Collection<? extends E> c)	Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
void	clear()	Removes all of the elements from this set (optional operation).
boolean	contains(Object o)	Returns true if this set contains the specified element.
boolean	containsAll(Collection<?> c)	Returns true if this set contains all of the elements of the specified collection.
boolean	equals(Object o)	Compares the specified object with this set for equality.
int	hashCode()	Returns the hash code value for this set.
boolean	isEmpty()	Returns true if this set contains no elements.
Iterator<E>	iterator()	Returns an iterator over the elements in this set.
static Set	of()	Returns an immutable set containing zero elements.
static Set	of(E e1)	Returns an immutable set containing one element.
static Set	of(E... elements)	Returns an immutable set containing an arbitrary number of elements.
static Set	of(E e1, E e2)	Returns an immutable set containing two elements.
static Set	of(E e1, E e2, E e3)	Returns an immutable set containing three elements.
static Set	of(E e1, E e2, E e3, E e4)	Returns an immutable set containing four elements.
static Set	of(E e1, E e2, E e3, E e4, E e5)	Returns an immutable set containing five elements.
static Set	of(E e1, E e2, E e3, E e4, E e5, E e6)	Returns an immutable set containing six elements.
static Set	of(E e1, E e2, E e3, E e4, E e5, E e6, E e7)	Returns an immutable set containing seven elements.
static Set	of(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8)	Returns an immutable set containing eight elements.
static Set	of(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9)	Returns an immutable set containing nine elements.
static Set	of(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9, E e10)	Returns an immutable set containing ten elements.
boolean	remove(Object o)	Removes the specified element from this set if it is present (optional operation).
boolean	removeAll(Collection<?> c)	Removes from this set all of its elements that are contained in the specified collection (optional operation).
boolean	retainAll(Collection<?> c)	Retains only the elements in this set that are contained in the specified collection (optional operation).
int	size()	Returns the number of elements in this set (its cardinality).
default Spliterator<E>	spliterator()	Creates a Spliterator over the elements in this set.
Object[]	toArray()	Returns an array containing all of the elements in this set.
T[]	toArray(T[] a)	Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.

   * ### Methods inherited from interface java.util.[Collection](../../java/util/Collection.html "interface in java.util")  
   `[parallelStream](../../java/util/Collection.html#parallelStream--), [removeIf](../../java/util/Collection.html#removeIf-java.util.function.Predicate-), [stream](../../java/util/Collection.html#stream--)`  
   * ### Methods inherited from interface java.lang.[Iterable](../../java/lang/Iterable.html "interface in java.lang")  
   `[forEach](../../java/lang/Iterable.html#forEach-java.util.function.Consumer-)`

Method Detail

 * #### size  
 int size()  
 Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns`Integer.MAX_VALUE`.  
 Specified by:  
 `[size](../../java/util/Collection.html#size--)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Returns:  
 the number of elements in this set (its cardinality)  
 * #### isEmpty  
 boolean isEmpty()  
 Returns `true` if this set contains no elements.  
 Specified by:  
 `[isEmpty](../../java/util/Collection.html#isEmpty--)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Returns:  
 `true` if this set contains no elements  
 * #### contains  
 boolean contains([Object](../../java/lang/Object.html "class in java.lang") o)  
 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)`.  
 Specified by:  
 `[contains](../../java/util/Collection.html#contains-java.lang.Object-)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Parameters:  
 `o` \- element whose presence in this set is to be tested  
 Returns:  
 `true` if this set contains the specified element  
 Throws:  
 `[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if the type of the specified element is incompatible with this set ([optional](Collection.html#optional-restrictions))  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified element is null and this set does not permit null elements ([optional](Collection.html#optional-restrictions))  
 * #### iterator  
 [Iterator](../../java/util/Iterator.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")> iterator()  
 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).  
 Specified by:  
 `[iterator](../../java/util/Collection.html#iterator--)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Specified by:  
 `[iterator](../../java/lang/Iterable.html#iterator--)` in interface `[Iterable](../../java/lang/Iterable.html "interface in java.lang")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Returns:  
 an iterator over the elements in this set  
 * #### toArray  
 [Object](../../java/lang/Object.html "class in java.lang")[] toArray()  
 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.  
 Specified by:  
 `[toArray](../../java/util/Collection.html#toArray--)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Returns:  
 an array containing all the elements in this set  
 * #### toArray  
 <T> T[] toArray(T[] a)  
 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()](../../java/util/Set.html#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]);  
  Note that `toArray(new Object[0])` is identical in function to`toArray()`.  
 Specified by:  
 `[toArray](../../java/util/Collection.html#toArray-T:A-)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Type Parameters:  
 `T` \- the runtime type of the array to contain the collection  
 Parameters:  
 `a` \- the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.  
 Returns:  
 an array containing all the elements in this set  
 Throws:  
 `[ArrayStoreException](../../java/lang/ArrayStoreException.html "class in java.lang")` \- if the runtime type of the specified array is not a supertype of the runtime type of every element in this set  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified array is null  
 * #### add  
 boolean add([E](../../java/util/Set.html "type parameter in Set") e)  
 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](../../java/util/Collection.html#add-E-). Individual set implementations should clearly document any restrictions on the elements that they may contain.  
 Specified by:  
 `[add](../../java/util/Collection.html#add-E-)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Parameters:  
 `e` \- element to be added to this set  
 Returns:  
 `true` if this set did not already contain the specified element  
 Throws:  
 `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the `add` operation is not supported by this set  
 `[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if the class of the specified element prevents it from being added to this set  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified element is null and this set does not permit null elements  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if some property of the specified element prevents it from being added to this set  
 * #### remove  
 boolean remove([Object](../../java/lang/Object.html "class in java.lang") o)  
 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.)  
 Specified by:  
 `[remove](../../java/util/Collection.html#remove-java.lang.Object-)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Parameters:  
 `o` \- object to be removed from this set, if present  
 Returns:  
 `true` if this set contained the specified element  
 Throws:  
 `[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if the type of the specified element is incompatible with this set ([optional](Collection.html#optional-restrictions))  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified element is null and this set does not permit null elements ([optional](Collection.html#optional-restrictions))  
 `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the `remove` operation is not supported by this set  
 * #### containsAll  
 boolean containsAll([Collection](../../java/util/Collection.html "interface in java.util")<?> c)  
 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.  
 Specified by:  
 `[containsAll](../../java/util/Collection.html#containsAll-java.util.Collection-)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Parameters:  
 `c` \- collection to be checked for containment in this set  
 Returns:  
 `true` if this set contains all of the elements of the specified collection  
 Throws:  
 `[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if the types of one or more elements in the specified collection are incompatible with this set ([optional](Collection.html#optional-restrictions))  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified collection contains one or more null elements and this set does not permit null elements ([optional](Collection.html#optional-restrictions)), or if the specified collection is null  
 See Also:  
 [contains(Object)](../../java/util/Set.html#contains-java.lang.Object-)  
 * #### addAll  
 boolean addAll([Collection](../../java/util/Collection.html "interface in java.util")<? extends [E](../../java/util/Set.html "type parameter in Set")> c)  
 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.  
 Specified by:  
 `[addAll](../../java/util/Collection.html#addAll-java.util.Collection-)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Parameters:  
 `c` \- collection containing elements to be added to this set  
 Returns:  
 `true` if this set changed as a result of the call  
 Throws:  
 `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the `addAll` operation is not supported by this set  
 `[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if the class of an element of the specified collection prevents it from being added to this set  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified collection contains one or more null elements and this set does not permit null elements, or if the specified collection is null  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if some property of an element of the specified collection prevents it from being added to this set  
 See Also:  
 [add(Object)](../../java/util/Set.html#add-E-)  
 * #### retainAll  
 boolean retainAll([Collection](../../java/util/Collection.html "interface in java.util")<?> c)  
 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.  
 Specified by:  
 `[retainAll](../../java/util/Collection.html#retainAll-java.util.Collection-)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Parameters:  
 `c` \- collection containing elements to be retained in this set  
 Returns:  
 `true` if this set changed as a result of the call  
 Throws:  
 `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the `retainAll` operation is not supported by this set  
 `[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if the class of an element of this set is incompatible with the specified collection ([optional](Collection.html#optional-restrictions))  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if this set contains a null element and the specified collection does not permit null elements ([optional](Collection.html#optional-restrictions)), or if the specified collection is null  
 See Also:  
 [remove(Object)](../../java/util/Set.html#remove-java.lang.Object-)  
 * #### removeAll  
 boolean removeAll([Collection](../../java/util/Collection.html "interface in java.util")<?> c)  
 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.  
 Specified by:  
 `[removeAll](../../java/util/Collection.html#removeAll-java.util.Collection-)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Parameters:  
 `c` \- collection containing elements to be removed from this set  
 Returns:  
 `true` if this set changed as a result of the call  
 Throws:  
 `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the `removeAll` operation is not supported by this set  
 `[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if the class of an element of this set is incompatible with the specified collection ([optional](Collection.html#optional-restrictions))  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if this set contains a null element and the specified collection does not permit null elements ([optional](Collection.html#optional-restrictions)), or if the specified collection is null  
 See Also:  
 [remove(Object)](../../java/util/Set.html#remove-java.lang.Object-), [contains(Object)](../../java/util/Set.html#contains-java.lang.Object-)  
 * #### clear  
 void clear()  
 Removes all of the elements from this set (optional operation). The set will be empty after this call returns.  
 Specified by:  
 `[clear](../../java/util/Collection.html#clear--)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Throws:  
 `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the `clear` method is not supported by this set  
 * #### equals  
 boolean equals([Object](../../java/lang/Object.html "class in java.lang") o)  
 Compares the specified object with this set for equality. Returns`true` if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.  
 Specified by:  
 `[equals](../../java/util/Collection.html#equals-java.lang.Object-)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Overrides:  
 `[equals](../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
 Parameters:  
 `o` \- object to be compared for equality with this set  
 Returns:  
 `true` if the specified object is equal to this set  
 See Also:  
 [Object.hashCode()](../../java/lang/Object.html#hashCode--), [HashMap](../../java/util/HashMap.html "class in java.util")  
 * #### hashCode  
 int hashCode()  
 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()](../../java/lang/Object.html#hashCode--).  
 Specified by:  
 `[hashCode](../../java/util/Collection.html#hashCode--)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Overrides:  
 `[hashCode](../../java/lang/Object.html#hashCode--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
 Returns:  
 the hash code value for this set  
 See Also:  
 [Object.equals(Object)](../../java/lang/Object.html#equals-java.lang.Object-), [equals(Object)](../../java/util/Set.html#equals-java.lang.Object-)  
 * #### spliterator  
 default [Spliterator](../../java/util/Spliterator.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")> spliterator()  
 Creates a `Spliterator` over the elements in this set.  
 The `Spliterator` reports [Spliterator.DISTINCT](../../java/util/Spliterator.html#DISTINCT). Implementations should document the reporting of additional characteristic values.  
 Specified by:  
 `[spliterator](../../java/util/Collection.html#spliterator--)` in interface `[Collection](../../java/util/Collection.html "interface in java.util")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Specified by:  
 `[spliterator](../../java/lang/Iterable.html#spliterator--)` in interface `[Iterable](../../java/lang/Iterable.html "interface in java.lang")<[E](../../java/util/Set.html "type parameter in Set")>`  
 Implementation Requirements:  
 The default implementation creates a_[late-binding](Spliterator.html#binding)_ spliterator from the set's `Iterator`. The spliterator inherits the_fail-fast_ properties of the set's iterator.  
  The created `Spliterator` additionally reports[Spliterator.SIZED](../../java/util/Spliterator.html#SIZED).  
 Implementation Note:  
 The created `Spliterator` additionally reports[Spliterator.SUBSIZED](../../java/util/Spliterator.html#SUBSIZED).  
 Returns:  
 a `Spliterator` over the elements in this set  
 Since:  
 1.8  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of()  
 Returns an immutable set containing zero elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Returns:  
 an empty `Set`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1)  
 Returns an immutable set containing one element. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the single element  
 Returns:  
 a `Set` containing the specified element  
 Throws:  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the element is `null`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1,  
                      E e2)  
 Returns an immutable set containing two elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the first element  
 `e2` \- the second element  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the elements are duplicates  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1,  
                      E e2,  
                      E e3)  
 Returns an immutable set containing three elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the first element  
 `e2` \- the second element  
 `e3` \- the third element  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if there are any duplicate elements  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1,  
                      E e2,  
                      E e3,  
                      E e4)  
 Returns an immutable set containing four elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the first element  
 `e2` \- the second element  
 `e3` \- the third element  
 `e4` \- the fourth element  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if there are any duplicate elements  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1,  
                      E e2,  
                      E e3,  
                      E e4,  
                      E e5)  
 Returns an immutable set containing five elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the first element  
 `e2` \- the second element  
 `e3` \- the third element  
 `e4` \- the fourth element  
 `e5` \- the fifth element  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if there are any duplicate elements  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1,  
                      E e2,  
                      E e3,  
                      E e4,  
                      E e5,  
                      E e6)  
 Returns an immutable set containing six elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the first element  
 `e2` \- the second element  
 `e3` \- the third element  
 `e4` \- the fourth element  
 `e5` \- the fifth element  
 `e6` \- the sixth element  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if there are any duplicate elements  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1,  
                      E e2,  
                      E e3,  
                      E e4,  
                      E e5,  
                      E e6,  
                      E e7)  
 Returns an immutable set containing seven elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the first element  
 `e2` \- the second element  
 `e3` \- the third element  
 `e4` \- the fourth element  
 `e5` \- the fifth element  
 `e6` \- the sixth element  
 `e7` \- the seventh element  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if there are any duplicate elements  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1,  
                      E e2,  
                      E e3,  
                      E e4,  
                      E e5,  
                      E e6,  
                      E e7,  
                      E e8)  
 Returns an immutable set containing eight elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the first element  
 `e2` \- the second element  
 `e3` \- the third element  
 `e4` \- the fourth element  
 `e5` \- the fifth element  
 `e6` \- the sixth element  
 `e7` \- the seventh element  
 `e8` \- the eighth element  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if there are any duplicate elements  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1,  
                      E e2,  
                      E e3,  
                      E e4,  
                      E e5,  
                      E e6,  
                      E e7,  
                      E e8,  
                      E e9)  
 Returns an immutable set containing nine elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the first element  
 `e2` \- the second element  
 `e3` \- the third element  
 `e4` \- the fourth element  
 `e5` \- the fifth element  
 `e6` \- the sixth element  
 `e7` \- the seventh element  
 `e8` \- the eighth element  
 `e9` \- the ninth element  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if there are any duplicate elements  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null`  
 Since:  
 9  
 * #### of  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E e1,  
                      E e2,  
                      E e3,  
                      E e4,  
                      E e5,  
                      E e6,  
                      E e7,  
                      E e8,  
                      E e9,  
                      E e10)  
 Returns an immutable set containing ten elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `e1` \- the first element  
 `e2` \- the second element  
 `e3` \- the third element  
 `e4` \- the fourth element  
 `e5` \- the fifth element  
 `e6` \- the sixth element  
 `e7` \- the seventh element  
 `e8` \- the eighth element  
 `e9` \- the ninth element  
 `e10` \- the tenth element  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if there are any duplicate elements  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null`  
 Since:  
 9  
 * #### of  
 [@SafeVarargs](../../java/lang/SafeVarargs.html "annotation in java.lang")  
 static <E> [Set](../../java/util/Set.html "interface in java.util")<E> of(E... elements)  
 Returns an immutable set containing an arbitrary number of elements. See [Immutable Set Static Factory Methods](#immutable) for details.  
 API Note:  
 This method also accepts a single array as an argument. The element type of the resulting set will be the component type of the array, and the size of the set will be equal to the length of the array. To create a set with a single element that is an array, do the following:  
 ```  
      String[] array = ... ;  
      Set<String[]> list = Set.<String[]>of(array);  
        
 ```  
  This will cause the [Set.of(E)](../../java/util/Set.html#of-E-) method to be invoked instead.  
 Type Parameters:  
 `E` \- the `Set`'s element type  
 Parameters:  
 `elements` \- the elements to be contained in the set  
 Returns:  
 a `Set` containing the specified elements  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if there are any duplicate elements  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if an element is `null` or if the array is `null`  
 Since:  
 9

Set (Java SE 9 & JDK 9 ) (original) (raw)

Method Summary

Method Detail