com.koloboke.collect.map

Interface ObjObjMap<K,V>

All Superinterfaces:

Container, Map<K,V>

All Known Subinterfaces:

HashObjObjMap<K,V>

public interface ObjObjMap<K,V>
extends Map<K,V>, Container

The library's extension of the classic Map interface.

See Also:

ObjObjMapFactory, @KolobokeMap

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
ObjObjCursor<K,V>	cursor() Returns a new cursor over the entries of this map.
ObjSet<Map.Entry<K,V>>	entrySet()
boolean	forEachWhile(BiPredicate<? super K,? super V> predicate) Checks the given predicate on each entry in this map until all entries have been processed or the predicate returns false for some entry, or throws an Exception.
Equivalence<K>	keyEquivalence() Returns the equivalence strategy for keys in this map.
ObjSet<K>	keySet()
boolean	removeIf(BiPredicate<? super K,? super V> filter) Removes all of the entries of this collection that satisfy the given predicate.
Equivalence<V>	valueEquivalence() Returns the equivalence strategy for values in this map.
ObjCollection<V>	values()

Methods inherited from interface Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Methods inherited from interface com.koloboke.collect.Container

clear, ensureCapacity, isEmpty, shrink, size, sizeAsLong

Method Detail

keyEquivalence

@Nonnull
Equivalence<K> keyEquivalence()

Returns the equivalence strategy for keys in this map. All methods in the Map interface which defined in terms of Object.equals(Object) equality of key objects (almost all methods, actually), are supposed to use this equivalence instead.

Returns:

the equivalence strategy for keys in this map

See Also:

HashObjObjMapFactory.withKeyEquivalence(com.koloboke.collect.Equivalence<? super K>)

valueEquivalence

@Nonnull
Equivalence<V> valueEquivalence()

Returns the equivalence strategy for values in this map. All methods in the Map interface which defined in terms of Object.equals(Object) equality of value objects, for example, Map.containsValue(Object) and Map.remove(Object, Object), are supposed to use this equivalence instead.

Returns:

the equivalence strategy for values in this map

See Also:

ObjObjMapFactory.withValueEquivalence(com.koloboke.collect.Equivalence<? super V>)

forEachWhile

boolean forEachWhile(@Nonnull
                     BiPredicate<? super K,? super V> predicate)

Checks the given predicate on each entry in this map until all entries have been processed or the predicate returns false for some entry, or throws an Exception. Exceptions thrown by the predicate are relayed to the caller.

The entries will be processed in the same order as the entry set iterator unless that order is unspecified in which case implementations may use an order which differs from the entry set iterator.

If the map is empty, this method returns true immediately.

Parameters:

predicate - the predicate to be checked for each entry

Returns:

true if the predicate returned true for all entries of the map, false if it returned false for the entry

See Also:

Comparison of iteration options in the library

cursor

@Nonnull
ObjObjCursor<K,V> cursor()

Returns a new cursor over the entries of this map. It's order is always correspond to the entry set iterator order.

Basic cursor usage idiom is:

 for (ObjObjCursor<K, V> cur = map.cursor(); cur.moveNext();) {
     // Work with cur.key() and cur.value()
     // Call cur.remove() to remove the current entry
 }

Returns:

a new cursor over the entries of this map

See Also:

Comparison of iteration options in the library

keySet

@Nonnull
ObjSet<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

@Nonnull
ObjCollection<V> values()

Specified by:

values in interface Map<K,V>

entrySet

@Nonnull
ObjSet<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

removeIf

boolean removeIf(@Nonnull
                 BiPredicate<? super K,? super V> filter)

Removes all of the entries of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.

Parameters:

filter - a predicate which returns true for elements to be removed

Returns:

true if any elements were removed

Throws:

NullPointerException - if the specified filter is null

UnsupportedOperationException - if elements cannot be removed from this collection. Implementations may throw this exception if a matching element cannot be removed or if, in general, removal is not supported.

See Also:

Comparison of iteration options in the library