structure
Class OrderedList

java.lang.Object
  extended by structure.AbstractStructure
      extended by structure.OrderedList
All Implemented Interfaces:
OrderedStructure, Structure

public class OrderedList
extends AbstractStructure
implements OrderedStructure

A class that implements a collection of values that are kept in order. Base values must be comparable. Unlike Lists there is no notion of head or tail.


Field Summary
protected  int count
          Number of elements in list
protected  Node data
          Pointer to the smallest element, maintained as a singly linked list
protected  java.util.Comparator ordering
          The ordereding used to arange the values
 
Constructor Summary
OrderedList()
          Construct an empty ordered list
OrderedList(java.util.Comparator ordering)
          Construct an empty ordered list with alternative ordering
 
Method Summary
 void add(java.lang.Object value)
          Add a value to the ordered list, keeping values in order
 void clear()
          Remove all the elements from the ordered list
 boolean contains(java.lang.Object value)
          Determine if the ordered list contains a value
 boolean isEmpty()
          Determine if the list is empty
 java.util.Iterator iterator()
          Construct an iterator for traversing elements of ordered list in ascending order
 java.lang.Object remove(java.lang.Object value)
          Remove a value from the ordered list.
 int size()
          Determine the number of elements in the list
 java.lang.String toString()
          Generate string representation of the ordered list
 
Methods inherited from class structure.AbstractStructure
elements, hashCode, values
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface structure.Structure
elements, values
 

Field Detail

data

protected Node data
Pointer to the smallest element, maintained as a singly linked list


count

protected int count
Number of elements in list


ordering

protected java.util.Comparator ordering
The ordereding used to arange the values

Constructor Detail

OrderedList

public OrderedList()
Construct an empty ordered list

Postcondition:
constructs an empty ordered list

OrderedList

public OrderedList(java.util.Comparator ordering)
Construct an empty ordered list with alternative ordering

Parameters:
ordering - the Comparator to be used in comparison
Postcondition:
constructs an empty ordered list ordered by ordering
Method Detail

clear

public void clear()
Remove all the elements from the ordered list

Specified by:
clear in interface Structure
Postcondition:
the ordered list is empty

add

public void add(java.lang.Object value)
Add a value to the ordered list, keeping values in order

Specified by:
add in interface Structure
Parameters:
value - The value to be added to the list
Precondition:
value is non-null
Postcondition:
value is added to the list, leaving it in order

contains

public boolean contains(java.lang.Object value)
Determine if the ordered list contains a value

Specified by:
contains in interface Structure
Overrides:
contains in class AbstractStructure
Parameters:
value - The value sought in the list
Returns:
The actual value found, or null, if not
Precondition:
value is a non-null comparable object
Postcondition:
returns true iff contains value

remove

public java.lang.Object remove(java.lang.Object value)
Remove a value from the ordered list. At most one value is removed.

Specified by:
remove in interface Structure
Parameters:
value - The value to be removed
Returns:
The actual value removed from the list
Precondition:
value is non-null
Postcondition:
an instance of value is removed, if in list

size

public int size()
Determine the number of elements in the list

Specified by:
size in interface Structure
Returns:
The number of elements in the list
Precondition:
returns the number of elements in the ordered list

isEmpty

public boolean isEmpty()
Determine if the list is empty

Specified by:
isEmpty in interface Structure
Overrides:
isEmpty in class AbstractStructure
Returns:
True if the ordered list is empty
Postcondition:
returns true iff the size is non-zero

iterator

public java.util.Iterator iterator()
Construct an iterator for traversing elements of ordered list in ascending order

Specified by:
iterator in interface Structure
Returns:
An iterator traversing elements in ascending order
See Also:
AbstractIterator, Iterator, Enumeration, Structure.elements()
Postcondition:
returns an iterator over ordered list

toString

public java.lang.String toString()
Generate string representation of the ordered list

Overrides:
toString in class java.lang.Object
Returns:
String representing ordered list
Postcondition:
returns string representation of list