42 lines
1.5 KiB
Java
42 lines
1.5 KiB
Java
package net.datastructures;
|
|
import java.util.Iterator;
|
|
|
|
//begin#fragment Tree
|
|
/**
|
|
* An interface for a tree where nodes can have an arbitrary number of children.
|
|
//end#fragment Tree
|
|
* @author Michael Goodrich
|
|
//begin#fragment Tree
|
|
*/
|
|
public interface Tree<E> {
|
|
/** Returns the number of nodes in the tree. */
|
|
public int size();
|
|
/** Returns whether the tree is empty. */
|
|
public boolean isEmpty();
|
|
/** Returns an iterator of the elements stored in the tree. */
|
|
public Iterator<E> iterator();
|
|
/** Returns an iterable collection of the the nodes. */
|
|
public Iterable<Position<E>> positions();
|
|
/** Replaces the element stored at a given node. */
|
|
public E replace(Position<E> v, E e)
|
|
throws InvalidPositionException;
|
|
/** Returns the root of the tree. */
|
|
public Position<E> root() throws EmptyTreeException;
|
|
/** Returns the parent of a given node. */
|
|
public Position<E> parent(Position<E> v)
|
|
throws InvalidPositionException, BoundaryViolationException;
|
|
/** Returns an iterable collection of the children of a given node. */
|
|
public Iterable<Position<E>> children(Position<E> v)
|
|
throws InvalidPositionException;
|
|
/** Returns whether a given node is internal. */
|
|
public boolean isInternal(Position<E> v)
|
|
throws InvalidPositionException;
|
|
/** Returns whether a given node is external. */
|
|
public boolean isExternal(Position<E> v)
|
|
throws InvalidPositionException;
|
|
/** Returns whether a given node is the root of the tree. */
|
|
public boolean isRoot(Position<E> v)
|
|
throws InvalidPositionException;
|
|
}
|
|
//end#fragment Tree
|