com.carrotsearch.hppcrt

Interface IntObjectAssociativeContainer<VType>

All Superinterfaces:

java.lang.Iterable<IntObjectCursor<VType>>

All Known Subinterfaces:

IntObjectMap<VType>

All Known Implementing Classes:

IntObjectHashMap, ObjectIndexedHeapPriorityQueue

@Generated(date="2017-07-11T19:16:24+0200",
           value="KTypeVTypeAssociativeContainer.java")
public interface IntObjectAssociativeContainer<VType>
extends java.lang.Iterable<IntObjectCursor<VType>>

An associative container (alias: map, dictionary) from keys to (one or possibly more) values. Object keys must fulfill the contract of Object.hashCode() and Object.equals(Object).

Note that certain associative containers (like multimaps) may return the same key-value pair multiple times from iterators.

See Also:

IntContainer

Method Summary

Modifier and Type	Method and Description
int	capacity() Return the maximum number of keys this container is guaranteed to hold without reallocating.
boolean	containsKey(int key) Returns true if this container has an association to a value for the given key.
<T extends IntObjectPredicate<? super VType>> T	forEach(T predicate) Applies a predicate to container elements, as long as the predicate returns true.
<T extends IntObjectProcedure<? super VType>> T	forEach(T procedure) Applies a given procedure to all keys-value pairs in this container.
boolean	isEmpty()
java.util.Iterator<IntObjectCursor<VType>>	iterator() Returns a cursor over the entries (key-value pairs) in this map.
IntCollection	keys() Returns a collection view of keys of this container.
int	removeAll(IntContainer container) Removes all keys (and associated values) present in a given container.
int	removeAll(IntObjectPredicate<? super VType> predicate) Removes all keys (and associated values) for which the predicate on (key, value) pairs returns true.
int	removeAll(IntPredicate predicate) Removes all keys (and associated values) for which the predicate on keys returns true.
int	size()
ObjectCollection<VType>	values() Returns a collection view of all values present in this container.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

java.util.Iterator<IntObjectCursor<VType>> iterator()

Returns a cursor over the entries (key-value pairs) in this map. The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next(). To read the current key and value use the cursor's public fields. An example is shown below.

 for (IntShortCursor c : intShortMap)
 {
     System.out.println("index=" + c.index
       + " key=" + c.key
       + " value=" + c.value);
 }
 

The index field inside the cursor gives the internal index inside the container's implementation. The interpretation of this index depends on to the container.

Specified by:

iterator in interface java.lang.Iterable<IntObjectCursor<VType>>

containsKey

boolean containsKey(int key)

Returns true if this container has an association to a value for the given key.

size

int size()

Returns:

Returns the current size (number of assigned keys) in the container.

capacity

int capacity()

Return the maximum number of keys this container is guaranteed to hold without reallocating. The time for calculating the container's capacity may take O(n) time.

isEmpty

boolean isEmpty()

Returns:

Return true if this hash map contains no assigned keys.

removeAll

int removeAll(IntContainer container)

Removes all keys (and associated values) present in a given container.

Returns:

Returns the number of elements actually removed as a result of this call.

removeAll

int removeAll(IntPredicate predicate)

Removes all keys (and associated values) for which the predicate on keys returns true.

Returns:

Returns the number of elements actually removed as a result of this call.

removeAll

int removeAll(IntObjectPredicate<? super VType> predicate)

Removes all keys (and associated values) for which the predicate on (key, value) pairs returns true.

Returns:

Returns the number of elements actually removed as a result of this call.

forEach

<T extends IntObjectProcedure<? super VType>> T forEach(T procedure)

Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of IntObjectProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example.

forEach

<T extends IntObjectPredicate<? super VType>> T forEach(T predicate)

Applies a predicate to container elements, as long as the predicate returns true. The iteration is interrupted otherwise. Returns the argument (any subclass of IntObjectPredicate. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example. The iteration is continued as long as the predicate returns true.

keys

IntCollection keys()

Returns a collection view of keys of this container. The returned collection is a view over the key set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.

values

ObjectCollection<VType> values()

Returns a collection view of all values present in this container. The returned collection is a view over the value set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.