Package com.carrotsearch.hppc

Interface CharCharAssociativeContainer

All Superinterfaces:

java.lang.Iterable<CharCharCursor>

All Known Subinterfaces:

CharCharMap

All Known Implementing Classes:

CharCharHashMap, CharCharScatterMap

@Generated(date="2018-05-21T12:24:05+0200",
           value="KTypeVTypeAssociativeContainer.java")
public interface CharCharAssociativeContainer
extends java.lang.Iterable<CharCharCursor>

An associative container from keys to (one or possibly more) values.

See Also:

CharContainer

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(char key)	Returns true if this container has an association to a value for the given key.
<T extends CharCharProcedure> T	forEach(T procedure)	Applies a given procedure to all keys-value pairs in this container.
boolean	isEmpty()
java.util.Iterator<CharCharCursor>	iterator()	Returns a cursor over the entries (key-value pairs) in this map.
CharCollection	keys()	Returns a collection of keys of this container.
int	removeAll(CharContainer container)	Removes all keys (and associated values) present in a given container.
int	removeAll(CharCharPredicate predicate)	Removes all keys (and associated values) for which the predicate returns true.
int	removeAll(CharPredicate predicate)	Removes all keys (and associated values) for which the predicate returns true.
int	size()
CharContainer	values()	Returns a container view of all values present in this container.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

java.util.Iterator<CharCharCursor> 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<CharCharCursor>

containsKey

boolean containsKey(char 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.

isEmpty

boolean isEmpty()

Returns:

Return true if this hash map contains no assigned keys.

removeAll

int removeAll(CharContainer container)

Removes all keys (and associated values) present in a given container. An alias to:

 keys().removeAll(container)
 

but with no additional overhead.

Returns:

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

removeAll

int removeAll(CharPredicate predicate)

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

Returns:

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

removeAll

int removeAll(CharCharPredicate predicate)

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

Returns:

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

forEach

<T extends CharCharProcedure> T forEach(T procedure)

Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of CharCharProcedure. 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 CharCharPredicate> T forEach(T predicate)

Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass of CharCharPredicate. 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

CharCollection keys()

Returns a collection 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

CharContainer values()

Returns a container view of all values present in 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.