ObjectSet (object-sets 8.5.13-SNAPSHOT API)

All Superinterfaces:

java.util.Collection<K>, java.lang.Iterable<K>, it.unimi.dsi.fastutil.objects.ObjectCollection<K>, it.unimi.dsi.fastutil.objects.ObjectIterable<K>, java.util.Set<K>

All Known Subinterfaces:

ObjectSortedSet<K>

All Known Implementing Classes:

AbstractObjectSet, AbstractObjectSortedSet, ObjectArraySet, ObjectAVLTreeSet, ObjectLinkedOpenCustomHashSet, ObjectLinkedOpenHashSet, ObjectOpenCustomHashSet, ObjectOpenHashSet, ObjectRBTreeSet, ObjectSets.EmptySet, ObjectSets.Singleton, ObjectSets.SynchronizedSet, ObjectSets.UnmodifiableSet, ObjectSortedSets.EmptySet, ObjectSortedSets.Singleton, ObjectSortedSets.SynchronizedSortedSet, ObjectSortedSets.UnmodifiableSortedSet
```
public interface ObjectSet<K>
extends it.unimi.dsi.fastutil.objects.ObjectCollection<K>, java.util.Set<K>
```
A type-specific Set; provides some additional methods that use polymorphism to avoid (un)boxing.
Additionally, this interface strengthens (again) iterator().

See Also:

Set

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`it.unimi.dsi.fastutil.objects.ObjectIterator<K>`	`iterator()` Returns a type-specific iterator on the elements of this set.
`static <K> ObjectSet<K>`	`of()` Returns an immutable empty set.
`static <K> ObjectSet<K>`	`of(K... a)` Returns an immutable list with the elements given.
`static <K> ObjectSet<K>`	`of(K e)` Returns an immutable set with the element given.
`static <K> ObjectSet<K>`	`of(K e0, K e1)` Returns an immutable set with the elements given.
`static <K> ObjectSet<K>`	`of(K e0, K e1, K e2)` Returns an immutable set with the elements given.
`default it.unimi.dsi.fastutil.objects.ObjectSpliterator<K>`	`spliterator()` Returns a type-specific spliterator on the elements of this set.

Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - iterator
```
it.unimi.dsi.fastutil.objects.ObjectIterator<K> iterator()
```
    Returns a type-specific iterator on the elements of this set.
    
    Specified by:
    
    iterator in interface java.util.Collection<K>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<K>
    
    Specified by:
    
    iterator in interface it.unimi.dsi.fastutil.objects.ObjectCollection<K>
    
    Specified by:
    
    iterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>
    
    Specified by:
    
    iterator in interface java.util.Set<K>
    
    Returns:
    
    a type-specific iterator on the elements of this set.
  - spliterator
```
default it.unimi.dsi.fastutil.objects.ObjectSpliterator<K> spliterator()
```
    Returns a type-specific spliterator on the elements of this set.
    Set spliterators must report at least Spliterator.DISTINCT.
    See Set.spliterator() for more documentation on the requirements of the returned spliterator.
    
    Specified by:
    
    spliterator in interface java.util.Collection<K>
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<K>
    
    Specified by:
    
    spliterator in interface it.unimi.dsi.fastutil.objects.ObjectCollection<K>
    
    Specified by:
    
    spliterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>
    
    Specified by:
    
    spliterator in interface java.util.Set<K>
    
    Returns:
    
    Since:
    
    8.5.0
  - of
```
static <K> ObjectSet<K> of()
```
    Returns an immutable empty set.
    
    Returns:
    
    an immutable empty set.
  - of
```
static <K> ObjectSet<K> of(K e)
```
    Returns an immutable set with the element given.
    
    Parameters:
    
    e - an element.
    
    Returns:
    
    an immutable set containing e.
  - of
```
static <K> ObjectSet<K> of(K e0,
                           K e1)
```
    Returns an immutable set with the elements given.
    
    Parameters:
    
    e0 - the first element.
    
    e1 - the second element.
    
    Returns:
    
    an immutable set containing e0 and e1.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there were duplicate entries.
  - of
```
static <K> ObjectSet<K> of(K e0,
                           K e1,
                           K e2)
```
    Returns an immutable set with the elements given.
    
    Parameters:
    
    e0 - the first element.
    
    e1 - the second element.
    
    e2 - the third element.
    
    Returns:
    
    an immutable set containing e0, e1, and e2.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there were duplicate entries.
  - of
```
@SafeVarargs
static <K> ObjectSet<K> of(K... a)
```
    Returns an immutable list with the elements given.
    
    Parameters:
    
    a - the list of elements that will be in the final set.
    
    Returns:
    
    an immutable set containing the elements in a.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there are any duplicate entries.

Interface ObjectSet<K>

Method Summary

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Method Detail

iterator

spliterator

of

of

of

of

of