Interface SetTesterADT<K>

All Superinterfaces:

java.lang.Iterable<K>

All Known Implementing Classes:

ArrayListSetTester, BSTreeSetTester, RBTreeSetTester

public interface SetTesterADT<K>
extends java.lang.Iterable<K>

SetTester ADT specifies the operations needed to test different implementations of a set storing key values. It is not a full specification of a set operations, e.g., delete is not included. DO NOT CHANGE THIS INTERFACE.

Author:

CS367

Method Summary

Modifier and Type	Method and Description
void	add(K key) Add the key to the set.
void	clear() Clears all the keys in the set.
boolean	contains(K key) Return true iff the set contains the key.
void	displayTree(int maxDisplayLevels) Displays the set but only maxNumLevels from the top of the data structure used by the implementation.
java.util.Iterator<K>	iterator() Returns an iterator for the set.
int	size() Returns the number of keys in the set.
java.util.List<K>	subSet(K minValue, K maxValue) Returns the sorted list of keys in the tree that are in the specified range (inclusive of minValue, exclusive of maxValue).

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

void add(K key)

Add the key to the set.

Parameters:

key - the key to add

Throws:

java.lang.IllegalArgumentException - if the key is null

DuplicateKeyException - if the key is a duplicate

contains

boolean contains(K key)

Return true iff the set contains the key.

Parameters:

key - the key to search

Returns:

true iff the tester contains the key

Throws:

java.lang.IllegalArgumentException - if the key is null

subSet

java.util.List<K> subSet(K minValue,
                         K maxValue)

Returns the sorted list of keys in the tree that are in the specified range (inclusive of minValue, exclusive of maxValue).

Parameters:

minValue - the minimum value of the desired range (inclusive)

maxValue - the maximum value of the desired range (exclusive)

Returns:

the sorted list of keys in the specified range

Throws:

java.lang.IllegalArgumentException - if either minValue or maxValue is null, or minValue is larger than maxValue

clear

void clear()

Clears all the keys in the set.

size

int size()

Returns the number of keys in the set.

Returns:

the number of keys

displayTree

void displayTree(int maxDisplayLevels)

Displays the set but only maxNumLevels from the top of the data structure used by the implementation.

Parameters:

maxDisplayLevels - number of levels to display

iterator

java.util.Iterator<K> iterator()

Returns an iterator for the set.

Specified by:

iterator in interface java.lang.Iterable<K>

Returns:

the iterator