Interface Dictionary<K,V>

Type Parameters:

K - The key type.

V - The value type.

All Superinterfaces:

java.lang.Iterable<Dictionary.Entry<K,V>>

All Known Implementing Classes:

MysteryDictionaryImplementation

public interface Dictionary<K,V>
extends java.lang.Iterable<Dictionary.Entry<K,V>>

A Java interface for the Dictionary ADT.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Dictionary.Entry<K,V> A simple interface for key-value pairs.
static class	Dictionary.MissingKeyException An exception to indicate that a key is not stored in the dictionary.

Method Summary

Modifier and Type	Method and Description
void	add(K key, V value) Sets the value associated with a given key.
void	clear() Removes all entries from this dictionary.
boolean	contains(K key) Returns whether a specific key is in this dictionary.
V	getValue(K key) Returns the value associated with a given key.
boolean	isEmpty() Returns true if this dictionary is empty.
java.util.Iterator<Dictionary.Entry<K,V>>	iterator() Returns an iterator over the key-value pairs in the dictionary.
void	remove(K key) Removes a specific entry from this dictionary.
int	size() Returns the size of this dictionary.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

void add(K key,
         V value)

Sets the value associated with a given key. If the key didn't already exist in the dictionary, it gets added; otherwise, the new value replaces the old one associated with this key.

getValue

V getValue(K key)

Returns the value associated with a given key.

Throws:

Dictionary.MissingKeyException - if the key was not in the dictionary.

remove

void remove(K key)

Removes a specific entry from this dictionary.

Throws:

Dictionary.MissingKeyException - if the key was not in the dictionary.

contains

boolean contains(K key)

Returns whether a specific key is in this dictionary.

size

int size()

Returns the size of this dictionary.

isEmpty

boolean isEmpty()

Returns true if this dictionary is empty.

clear

void clear()

Removes all entries from this dictionary.

iterator

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

Returns an iterator over the key-value pairs in the dictionary. This iterator is silently invalidated if the dictionary is modified during the iterator's lifetime. The only exception to this is the iterator's own remove() method.

Specified by:

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