Package com.carrotsearch.hppc

Interface ObjectCollection<KType>

All Superinterfaces:

java.lang.Iterable<ObjectCursor<KType>>, ObjectContainer<KType>

All Known Subinterfaces:

ObjectDeque<KType>, ObjectIndexedContainer<KType>, ObjectSet<KType>

All Known Implementing Classes:

AbstractObjectCollection, ByteObjectHashMap.ValuesContainer, CharObjectHashMap.ValuesContainer, DoubleObjectHashMap.ValuesContainer, FloatObjectHashMap.ValuesContainer, IntObjectHashMap.ValuesContainer, LongObjectHashMap.ValuesContainer, ObjectArrayDeque, ObjectArrayList, ObjectByteHashMap.KeysContainer, ObjectCharHashMap.KeysContainer, ObjectDoubleHashMap.KeysContainer, ObjectFloatHashMap.KeysContainer, ObjectHashSet, ObjectIdentityHashSet, ObjectIntHashMap.KeysContainer, ObjectLongHashMap.KeysContainer, ObjectObjectHashMap.KeysContainer, ObjectObjectHashMap.ValuesContainer, ObjectScatterSet, ObjectShortHashMap.KeysContainer, ObjectStack, ShortObjectHashMap.ValuesContainer

@Generated(date="2024-05-16T12:00:00+0000",
           value="KTypeCollection.java")
public interface ObjectCollection<KType>
extends ObjectContainer<KType>

A collection allows basic, efficient operations on sets of elements (difference and intersection).

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all elements from this collection.
void	release()	Removes all elements from the collection and additionally releases any internal buffers.
int	removeAll(ObjectLookupContainer<? super KType> c)	Removes all elements in this collection that are present in c.
int	removeAll(ObjectPredicate<? super KType> predicate)	Removes all elements in this collection for which the given predicate returns true.
int	removeAll(KType e)	Removes all occurrences of e from this collection.
int	retainAll(ObjectLookupContainer<? super KType> c)	Keeps all elements in this collection that are present in c.
int	retainAll(ObjectPredicate<? super KType> predicate)	Keeps all elements in this collection for which the given predicate returns true.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.carrotsearch.hppc.ObjectContainer

contains, forEach, isEmpty, iterator, size, toArray, toArray

Method Detail

removeAll

int removeAll(KType e)

Removes all occurrences of e from this collection.

Parameters:

e - Element to be removed from this collection, if present.

Returns:

The number of removed elements as a result of this call.

removeAll

int removeAll(ObjectLookupContainer<? super KType> c)

Removes all elements in this collection that are present in c.

Returns:

Returns the number of removed elements.

removeAll

int removeAll(ObjectPredicate<? super KType> predicate)

Removes all elements in this collection for which the given predicate returns true.

Returns:

Returns the number of removed elements.

retainAll

int retainAll(ObjectLookupContainer<? super KType> c)

Keeps all elements in this collection that are present in c. Runs in time proportional to the number of elements in this collection. Equivalent of sets intersection.

Returns:

Returns the number of removed elements.

retainAll

int retainAll(ObjectPredicate<? super KType> predicate)

Keeps all elements in this collection for which the given predicate returns true.

Returns:

Returns the number of removed elements.

clear

void clear()

Removes all elements from this collection.

See Also:

release()

release

void release()

Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simple clear() should be a better alternative since it'll avoid reallocation.

See Also:

clear()