data_structures_free

net/datastructures/PositionList.java

@@ -0,0 +1,50 @@
+package net.datastructures;
+import java.util.Iterator;
+/**
+ * An interface for positional lists.
+ * @author Roberto Tamassia, Michael Goodrich
+ */
+//begin#fragment Header
+public interface PositionList<E> extends Iterable<E> {
+//end#fragment Header
+//begin#fragment List
+  /** Returns the number of elements in this list. */
+  public int size();
+  /** Returns whether the list is empty. */
+  public boolean isEmpty();
+  /** Returns the first node in the list. */
+  public Position<E> first();
+  /** Returns the last node in the list. */
+  public Position<E> last();
+  /** Returns the node after a given node in the list. */
+  public Position<E> next(Position<E> p) 
+    throws InvalidPositionException, BoundaryViolationException;
+  /** Returns the node before a given node in the list. */
+  public Position<E> prev(Position<E> p) 
+    throws InvalidPositionException, BoundaryViolationException;
+  /** Inserts an element at the front of the list, returning new position. */
+  public void addFirst(E e);
+  /** Inserts and element at the back of the list, returning new position. */
+  public void addLast(E e);
+  /** Inserts an element after the given node in the list. */
+  public void addAfter(Position<E> p, E e) 
+    throws InvalidPositionException;
+  /** Inserts an element before the given node in the list. */
+  public void addBefore(Position<E> p, E e) 
+    throws InvalidPositionException;
+  /** Removes a node from the list, returning the element stored there. */
+  public E remove(Position<E> p) throws InvalidPositionException;
+  /** Replaces the element stored at the given node, returning old element. */
+  public E set(Position<E> p, E e) throws InvalidPositionException;
+//end#fragment List
+//begin#fragment Positions
+  /** Returns an iterable collection of all the nodes in the list. */
+  public Iterable<Position<E>> positions();
+//end#fragment Positions
+//begin#fragment Iterator
+  /** Returns an iterator of all the elements in the list. */
+  public Iterator<E> iterator();
+//end#fragment Iterator
+//begin#fragment Tail
+}
+//end#fragment Tail