Module com.carrotsearch.hppc

Package com.carrotsearch.hppc

Interface ObjectSet<KType>

All Superinterfaces:

Iterable<ObjectCursor<KType>>, ObjectCollection<KType>, ObjectContainer<KType>

All Known Implementing Classes:

ObjectHashSet, ObjectIdentityHashSet

@Generated(date="2024-06-04T15:20:17+0200",
           value="KTypeSet.java")
public interface ObjectSet<KType>
extends ObjectCollection<KType>

A set of Objects.

Method Summary

Modifier and Type	Method	Description
boolean	add(KType k)	Adds k to the set.
int	addAll(ObjectContainer<? extends KType> container)	Adds all elements from the given ObjectContainer to this set.
String	visualizeKeyDistribution(int characters)	Visually depict the distribution of keys.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.carrotsearch.hppc.ObjectCollection

clear, release, removeAll, removeAll, removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppc.ObjectContainer

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

Method Details

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, does not replace the existing element with the argument.

visualizeKeyDistribution

String visualizeKeyDistribution(int characters)

Visually depict the distribution of keys.

Parameters:

characters - The number of characters to "squeeze" the entire buffer into.

Returns:

Returns a sequence of characters where '.' depicts an empty fragment of the internal buffer and 'X' depicts full or nearly full capacity within the buffer's range and anything between 1 and 9 is between.

addAll

int addAll(ObjectContainer<? extends KType> container)

Adds all elements from the given ObjectContainer to this set.

Returns:

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

Since:

0.9.1