ObjectByteAssociativeContainer (HPPC v0.5.2 API Documentation (JavaDoc))

All Superinterfaces:

java.lang.Iterable<ObjectByteCursor<KType>>

All Known Subinterfaces:

ObjectByteMap<KType>

All Known Implementing Classes:

ObjectByteOpenHashMap
```
@Generated(date="2013-07-09T09:54:21+0200",
           value="HPPC generated from: ObjectByteAssociativeContainer.java")
public interface ObjectByteAssociativeContainer<KType>
extends java.lang.Iterable<ObjectByteCursor<KType>>
```
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:
ObjectContainer

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear all keys and values in the container.
`boolean`	`containsKey(KType key)` Returns `true` if this container has an association to a value for the given key.
`<T extends ObjectByteProcedure<? super KType>> T`	`forEach(T procedure)` Applies a given procedure to all keys-value pairs in this container.
`boolean`	`isEmpty()`
`java.util.Iterator<ObjectByteCursor<KType>>`	`iterator()` Returns a cursor over the entries (key-value pairs) in this map.
`ObjectCollection<KType>`	`keys()` Returns a collection of keys of this container.
`int`	`removeAll(ObjectContainer<? extends KType> container)` Removes all keys (and associated values) present in a given container.
`int`	`removeAll(ObjectPredicate<? super KType> predicate)` Removes all keys (and associated values) for which the predicate returns `true`.
`int`	`size()`
`ByteContainer`	`values()` Returns a container view of all values present in this container.

- Method Detail
  - iterator
```
java.util.Iterator<ObjectByteCursor<KType>> 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<ObjectByteCursor<KType>>
  - containsKey
```
boolean containsKey(KType 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(ObjectContainer<? extends KType> 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(ObjectPredicate<? super KType> predicate)
```
    Removes all keys (and associated values) for which the predicate returns true. 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.
  - forEach
```
<T extends ObjectByteProcedure<? super KType>> T forEach(T procedure)
```
    Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of ObjectByteProcedure. 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.
  - clear
```
void clear()
```
    Clear all keys and values in the container.
  - keys
```
ObjectCollection<KType> 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
```
ByteContainer 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.

Interface ObjectByteAssociativeContainer<KType>

Method Summary

Method Detail

iterator

containsKey

size

isEmpty

removeAll

removeAll

forEach

clear

keys

values