com.carrotsearch.hppcrt

Interface ObjectSet<KType>

All Superinterfaces:

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

All Known Implementing Classes:

ObjectHashSet, ObjectIdentityHashSet

@Generated(date="2017-07-11T19:16:23+0200",
           value="KTypeSet.java")
public interface ObjectSet<KType>
extends ObjectCollection<KType>

A set of Objects.

Method Summary

Modifier and Type	Method and Description
boolean	add(KType k) Adds k to the set.
int	addAll(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable) Adds all elements from a given iterable to this set.
int	addAll(ObjectContainer<? extends KType> container) Adds all elements from a given container to this set.
boolean	remove(KType key) Remove all elements of the set matching key.

Methods inherited from interface com.carrotsearch.hppcrt.ObjectCollection

clear, removeAll, removeAll, removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppcrt.ObjectContainer

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

boolean add(KType k)

Adds k to the set.

Returns:

Returns true if this element was not part of the set before. Returns false if an equal element is already part of the set, and leaves the set unchanged. .

addAll

int addAll(ObjectContainer<? extends KType> container)

Adds all elements from a given container to this set.

Returns:

Returns the number of elements actually added as a result of this call (not previously present in the set).

addAll

int addAll(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)

Adds all elements from a given iterable to this set.

Returns:

Returns the number of elements actually added as a result of this call (not previously present in the set).

remove

boolean remove(KType key)

Remove all elements of the set matching key. Returns true if key was present in the set and has been successfully removed. This is indeed an alias for ObjectCollection.removeAll(key) > 0

See Also:

ObjectCollection.removeAll(KType)