BinarySearchTreeInterface

Type Parameters:

E - The type of element that the BinarySearchTree will hold. Please note that E must implement the KeyElementInterface or some super class of E must implement the KeyElementInterface.

K - The type of key that all elements must contain. Please note that K must implement the Comparable interface or some super class of K must implement the Comparable interface.
```
public interface BinarySearchTreeInterface<E extends KeyedElementInterface<K>,K extends java.lang.Comparable<? super K>>
```
Author:

sameh

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`balance()` This method is used to balance the `BinarySearchTree`.
`BinarySearchTreeInterface<E,K>`	`copy()` Method to make a deep copy of the BinarySearchTree.
`void`	`delete(K key)` This is the public method used to delete a TreeItem from the `BinarySearchTree` based on the specified key.
`E`	`find(K key)` Method to find and retrieve the TreeItem with the given key if it is in the BinarySearchTree.
`TreeNode<E,K>`	`getRoot()` Method to get the current root of this BinarySearchTree
`int`	`height()` This method is used to obtain the height of the `BinarySearchTree`.
`void`	`insert(E element)` Method to insert the given TreeItem into the BinarySearchTree
`boolean`	`isBalanced()` This is the method the user calls to find out if the `BinarySearchTree` is balanced.
`boolean`	`isEmpty()` Method to find out if the BinarySearchTree is empty
`TreeElementIterator<E,K>`	`iterator()` Creates and returns a `TreeElementIterator`
`void`	`makeEmpty()` Method to remove all entries from the BinarySearchTree.
`void`	`setRoot(TreeNode<E,K> root)` Method to set set the root of this BinarySearchTree

- Method Detail
  - getRoot
```
TreeNode<E,K> getRoot()
```
    Method to get the current root of this BinarySearchTree
    
    Returns:
    
    The root TreeNode for this BinarySearchTree
  - setRoot
```
void setRoot(TreeNode<E,K> root)
```
    Method to set set the root of this BinarySearchTree
    
    Parameters:
    
    root - The new root of this BinarySearchTree
  - isEmpty
```
boolean isEmpty()
```
    Method to find out if the BinarySearchTree is empty
    
    Returns:
    
    Returns true if the root in null, otherwise, returns false
  - makeEmpty
```
void makeEmpty()
```
    Method to remove all entries from the BinarySearchTree.
  - copy
```
BinarySearchTreeInterface<E,K> copy()
```
    Method to make a deep copy of the BinarySearchTree.
    
    Returns:
    
    An identical deep copy of the existing BinarySearchTree.
  - find
```
E find(K key)
```
    Method to find and retrieve the TreeItem with the given key if it is in the BinarySearchTree.
    
    Parameters:
    
    key - The key that the user wishes to search for
    
    Returns:
    
    The element with the given key if found. Otherwise, returns null
  - insert
```
void insert(E element)
```
    Method to insert the given TreeItem into the BinarySearchTree
    
    Parameters:
    
    element - The element to insert into the BinarySearchTree
  - delete
```
void delete(K key)
     throws TreeException
```
    This is the public method used to delete a TreeItem from the BinarySearchTree based on the specified key.
    
    Parameters:
    
    key - The key of the TreeItem the user wishes to delete from the BinarySearchTree.
    
    Throws:
    
    TreeException
  - height
```
int height()
```
    This method is used to obtain the height of the BinarySearchTree.
    
    Returns:
    
    Returns the height of the BinarySearchTree.
  - isBalanced
```
boolean isBalanced()
```
    This is the method the user calls to find out if the BinarySearchTree is balanced.
    
    Returns:
    
    Returns true if the BinarySearchTree is balanced, false otherwise.
  - balance
```
void balance()
```
    This method is used to balance the BinarySearchTree.
  - iterator
```
TreeElementIterator<E,K> iterator()
```
    Creates and returns a TreeElementIterator
    
    Returns:
    
    An instance of TreeElementIterator which will use this BinarySearchTree.

Interface BinarySearchTreeInterface<E extends KeyedElementInterface<K>,K extends java.lang.Comparable<? super K>>

Method Summary

Method Detail

getRoot

setRoot

isEmpty

makeEmpty

copy

find

insert

delete

height

isBalanced

balance

iterator