com.augustbonds.foundation

Class Dictionary<K,V>

java.lang.Object

com.augustbonds.foundation.Dictionary<K,V>

Type Parameters:

K - The type of key in the Dictionary

V - The type of the values stored in the Dictionary

All Implemented Interfaces:

Iterable<Dictionary.Entry<K,V>>

public class Dictionary<K,V>
extends Object
implements Iterable<Dictionary.Entry<K,V>>

The Dictionary class acts as a lookup table for values of type V with keys of type K. The type K must implement both hashCode() and a corresponding equals() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Dictionary.Entry<K,V> The interface of key-value pairs accessed through the Dictionary Iterator.

Constructor Summary

Constructors

Constructor and Description
Dictionary() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	forEach(java.util.function.BiConsumer<K,V> consumer) Perform an action on each key-value pair stored in the dictionary.
V	get(K key) Get the value corresponding the given key.
Iterator<Dictionary.Entry<K,V>>	iterator() Iterate over the key-value pairs stored in the dictionary.
void	put(K key, V value) Store a value and a corresponding key.
int	size() The number key-value pairs stored in the dictionary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Dictionary

public Dictionary()

Default constructor.

Method Detail

get

public V get(K key)

Get the value corresponding the given key.

Parameters:

key - The key

Returns:

A value, or null.

put

public void put(K key,
                V value)

Store a value and a corresponding key.

Parameters:

key - A key

value - A value

forEach

public void forEach(java.util.function.BiConsumer<K,V> consumer)

Perform an action on each key-value pair stored in the dictionary.

Parameters:

consumer - The action to perform on each key-value pair in the dictionary.

size

public int size()

The number key-value pairs stored in the dictionary

Returns:

The number of key-value pairs in the dictionary

iterator

public Iterator<Dictionary.Entry<K,V>> iterator()

Iterate over the key-value pairs stored in the dictionary.

Specified by:

iterator in interface Iterable<Dictionary.Entry<K,V>>

Returns:

An Iterator over this dictionary