DictionaryADT

Type Parameters:
K - class representing the key, should implement the Comparable interface

All Superinterfaces:

java.lang.Iterable<K>
```
public interface DictionaryADT<K extends java.lang.Comparable<K>>
extends java.lang.Iterable<K>
```
The Dictionary ADT stores unique keys. Operations are provided to insert, lookup, and delete information as well as to go through the keys in order from smallest to largest (based on the ordering given by compareTo). Additionally, the Dictionary ADT provides some methods that give insight about the relative efficiency of a particular map: the size (# of keys) and the total path length. The total path length is the sum of the lengths of the paths to each key. Thus, one measure of the average lookup time is (total path length)/size. The Dictionary does not allow null keys to be added. DO NOT CHANGE THIS FILE

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`delete(K key)` Deletes the given key from the Dictionary.
`void`	`insert(K key)` Inserts the given key into the Dictionary if the key is not already in the Dictionary.
`boolean`	`isEmpty()` Returns true if and only if the Dictionary is empty.
`java.util.Iterator<K>`	`iterator()` Returns an iterator over the Dictionary that iterates over the keys in the Dictionary in order from smallest to largest.
`K`	`lookup(K key)` Searches for the given key in the Dictionary and returns the key stored in the Dictionary.
`int`	`size()` Returns the number of keys in the Dictionary.
`int`	`totalPathLength()` Returns the total path length.

- Method Detail
  - insert
```
void insert(K key)
            throws DuplicateException
```
    Inserts the given key into the Dictionary if the key is not already in the Dictionary. If the key is already in the Dictionary, a DuplicatException is thrown.
    
    Parameters:
    key - the key to insert into the Dictionary
    
    Throws:
    
    DuplicateException - if the key is already in the Dictionary
    
    java.lang.IllegalArgumentException - if the key is null
  - delete
```
boolean delete(K key)
```
    Deletes the given key from the Dictionary. If the key is in the Dictionary, the key is deleted and true is returned. If the key is not in the Dictionary, the Dictionary is unchanged and false is returned.
    
    Parameters:
    key - the key to delete from the Dictionary
    
    Returns:
    true if the deletion is successful (i.e., the key was in the Dictionary and has been removed), false otherwise (i.e., the key was not in the Dictionary)
  - lookup
```
K lookup(K key)
```
    Searches for the given key in the Dictionary and returns the key stored in the Dictionary. If the key is not in the Dictionary, null is returned.
    
    Parameters:
    key - the key to search for
    
    Returns:
    the key from the Dictionary, if the key is in the Dictionary; null if the key is not in the Dictionary
  - isEmpty
```
boolean isEmpty()
```
    Returns true if and only if the Dictionary is empty.
    
    Returns:
    true if the Dictionary is empty, false otherwise
  - size
```
int size()
```
    Returns the number of keys in the Dictionary.
    
    Returns:
    the number of keys in the Dictionary
  - totalPathLength
```
int totalPathLength()
```
    Returns the total path length. The total path length is the sum of the lengths of the paths to each (key, value) pair.
    
    Returns:
    the total path length
  - iterator
```
java.util.Iterator<K> iterator()
```
    Returns an iterator over the Dictionary that iterates over the keys in the Dictionary in order from smallest to largest.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<K extends java.lang.Comparable<K>>
    
    Returns:
    an iterator over the keys in the Dictionary in order

Interface DictionaryADT<K extends java.lang.Comparable<K>>

Method Summary

Method Detail

insert

delete

lookup

isEmpty

size

totalPathLength

iterator