structure5
Class SinglyLinkedList<E>

java.lang.Object
  structure5.AbstractStructure<E>
      structure5.AbstractList<E>
          structure5.SinglyLinkedList<E>

All Implemented Interfaces:

Iterable<E>, List<E>, Structure<E>

public class SinglyLinkedList<E>
extends AbstractList<E>

An implementation of lists using singly linked elements, similar to that of java.util.LinkedList.

This class is a basic implementation of the List interface. Operations accessing or modifying the head of the list execute in constant time. Operations accessing or modifying the tail of the list execute in a time proportional to the length of the list. Singly linked lists are space-efficient, but tail-related operations may be more costly than with doubly linked lists.

Example usage: To place a copy of every unique parameter passed to a program into a SinglyLinkedList, we would use the following:

 public static void main(String[] arguments)
 {
     SinglyLinkedList argList = new SinglyLinkedList();
     for (int i = 0; i < arguments.length; i++){
           if (!argList.contains(arguments[i])){
               argList.add(arguments[i]);
         }
    }
    System.out.println(argList);
 }
 

See Also:

DoublyLinkedList, CircularList

Constructor Summary

SinglyLinkedList()
Construct an empty list.

Method Summary

void	add(E value) Add an object to tail of list.
void	add(int i, E o) Insert value at location.
void	addFirst(E value) Add a value to head of list.
void	addLast(E value) Add a value to tail of list.
void	clear() Remove all values from list.
boolean	contains(E value) Check to see if a value is in list.
E	get(int i) Get value at location i.
E	getFirst() Fetch first element of list.
E	getLast() Fetch last element of list.
int	indexOf(E value) Determine first location of a value in list.
Iterator<E>	iterator() Returns an iterator traversing list from head to tail.
int	lastIndexOf(E value) Determine last location of a value in list.
E	remove(E value) Remove a value from list.
E	remove(int i) Remove and return value at location i.
E	removeFirst() Remove a value from first element of list.
E	removeLast() Remove last value from list.
E	set(int i, E o) Set value stored at location i to object o, returning old value.
int	size() Determine number of elements in list.
String	toString() Construct a string representing list.

Methods inherited from class structure5.AbstractList

get, isEmpty, remove

Methods inherited from class structure5.AbstractStructure

elements, hashCode, values

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface structure5.Structure

elements, values

Constructor Detail

SinglyLinkedList

public SinglyLinkedList()

Construct an empty list.

Method Detail

add

public void add(E value)

Add an object to tail of list.

Specified by:

add in interface List<E>

Specified by:

add in interface Structure<E>

Overrides:

add in class AbstractList<E>

Parameters:

value - The value to be added to tail of list.

See Also:

AbstractList.addLast(E)

addFirst

public void addFirst(E value)

Add a value to head of list.

Specified by:

addFirst in interface List<E>

Overrides:

addFirst in class AbstractList<E>

Parameters:

value - The value to be added to head of list.

removeFirst

public E removeFirst()

Remove a value from first element of list.

Specified by:

removeFirst in interface List<E>

Overrides:

removeFirst in class AbstractList<E>

Returns:

The value actually removed.

addLast

public void addLast(E value)

Add a value to tail of list.

Specified by:

addLast in interface List<E>

Overrides:

addLast in class AbstractList<E>

Parameters:

value - The value to be added to tail of list.

removeLast

public E removeLast()

Remove last value from list.

Specified by:

removeLast in interface List<E>

Overrides:

removeLast in class AbstractList<E>

Returns:

The value actually removed.

getFirst

public E getFirst()

Fetch first element of list.

Specified by:

getFirst in interface List<E>

Overrides:

getFirst in class AbstractList<E>

Returns:

A reference to first element of list.

getLast

public E getLast()

Fetch last element of list.

Specified by:

getLast in interface List<E>

Overrides:

getLast in class AbstractList<E>

Returns:

A reference to last element of list.

contains

public boolean contains(E value)

Check to see if a value is in list.

Specified by:

contains in interface List<E>

Specified by:

contains in interface Structure<E>

Overrides:

contains in class AbstractList<E>

Parameters:

value - The value sought.

Returns:

True if value is within list.

remove

public E remove(E value)

Remove a value from list. At most one value will be removed.

Parameters:

value - The value to be removed.

Returns:

The actual value removed.

size

public int size()

Determine number of elements in list.

Returns:

The number of elements in list.

clear

public void clear()

Remove all values from list.

get

public E get(int i)

Get value at location i.

Parameters:

i - position of value to be retrieved.

Returns:

value retrieved from location i (returns null if i invalid)

set

public E set(int i,
             E o)

Set value stored at location i to object o, returning old value.

Parameters:

i - location of entry to be changed.

o - new value

Returns:

former value of ith entry of list.

add

public void add(int i,
                E o)

Insert value at location.

Parameters:

i - index of this new value

o - value to be stored

remove

public E remove(int i)

Remove and return value at location i.

Parameters:

i - position of value to be retrieved.

Returns:

value retrieved from location i (returns null if i invalid)

indexOf

public int indexOf(E value)

Determine first location of a value in list.

Parameters:

value - value sought

Returns:

index (0 is first element) of value, or -1

lastIndexOf

public int lastIndexOf(E value)

Determine last location of a value in list.

Parameters:

value - value sought.

Returns:

index (0 is first element) of value, or -1

iterator

public Iterator<E> iterator()

Returns an iterator traversing list from head to tail.

Returns:

An iterator to traverse list.

See Also:

AbstractIterator, Iterator, Enumeration, Structure.elements()

toString

public String toString()

Construct a string representing list.

Overrides:

toString in class Object

Returns:

A string representing list.