Package it.unimi.dsi.fastutil.objects

Interface ReferenceCollection<K>

All Superinterfaces:

Collection<K>, Iterable<K>, ObjectIterable<K>

All Known Subinterfaces:

ReferenceBigList<K>, ReferenceList<K>, ReferenceSet<K>, ReferenceSortedSet<K>

All Known Implementing Classes:

AbstractReferenceBigList, AbstractReferenceBigList.ReferenceRandomAccessSubList, AbstractReferenceBigList.ReferenceSubList, AbstractReferenceCollection, AbstractReferenceList, AbstractReferenceList.ReferenceRandomAccessSubList, AbstractReferenceList.ReferenceSubList, AbstractReferenceSet, AbstractReferenceSortedSet, ReferenceArrayList, ReferenceArraySet, ReferenceBigArrayBigList, ReferenceBigLists.EmptyBigList, ReferenceBigLists.ListBigList, ReferenceBigLists.Singleton, ReferenceBigLists.SynchronizedBigList, ReferenceBigLists.UnmodifiableBigList, ReferenceCollections.EmptyCollection, ReferenceCollections.IterableCollection, ReferenceImmutableList, ReferenceLinkedOpenHashSet, ReferenceLists.EmptyList, ReferenceLists.Singleton, ReferenceLists.SynchronizedList, ReferenceLists.SynchronizedRandomAccessList, ReferenceLists.UnmodifiableList, ReferenceLists.UnmodifiableRandomAccessList, ReferenceOpenHashBigSet, ReferenceOpenHashSet, ReferenceSets.EmptySet, ReferenceSets.Singleton, ReferenceSets.SynchronizedSet, ReferenceSets.UnmodifiableSet, ReferenceSortedSets.EmptySet, ReferenceSortedSets.Singleton, ReferenceSortedSets.SynchronizedSortedSet, ReferenceSortedSets.UnmodifiableSortedSet

public interface ReferenceCollection<K>
extends Collection<K>, ObjectIterable<K>

A type-specific Collection; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this class defines strengthens (again) iterator().

See Also:

• Collection

Method Summary

Modifier and Type	Method	Description
ObjectIterator<K>	iterator()	Returns a type-specific iterator on the elements of this collection.
default ObjectSpliterator<K>	spliterator()	Returns a type-specific spliterator on the elements of this collection.

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, size, stream, toArray, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Details

iterator

ObjectIterator<K> iterator()

Returns a type-specific iterator on the elements of this collection.

Specified by:

iterator in interface Collection<K>

Specified by:

iterator in interface Iterable<K>

Specified by:

iterator in interface ObjectIterable<K>

Returns:

a type-specific iterator on the elements of this collection.

See Also:

• Iterable.iterator()

API Notes:

This specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

spliterator

default ObjectSpliterator<K> spliterator()

Returns a type-specific spliterator on the elements of this collection.

See Collection.spliterator() for more documentation on the requirements of the returned spliterator.

Specified by:

spliterator in interface Collection<K>

Specified by:

spliterator in interface Iterable<K>

Specified by:

spliterator in interface ObjectIterable<K>

Returns:

a type-specific spliterator on the elements of this collection.

Since:

8.5.0

API Notes:

This specification strengthens the one given in Collection.spliterator().

Also, this is generally the only spliterator method subclasses should override.

Implementation Specification:

The default implementation returns a late-binding spliterator (see Spliterator for documentation on what binding policies mean) that wraps this instance's type specific iterator().

Additionally, it reports Spliterator.SIZED

Implementation Notes:

As this default implementation wraps the iterator, and Iterator is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator's trySplit() will have linear runtime.