LinkedList

java.lang.Object
- LinkedList<E>

All Implemented Interfaces:

java.lang.Iterable<E>
```
public class LinkedList<E>
extends java.lang.Object
implements java.lang.Iterable<E>
```
Linked List implementation which stores the reference to the creatures in each of the rooms. Must implement Iterable to allow the linked list to be iterted over in a for each loop

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`LinkedList.LinkedListIterator<E>` Iterator class for better loop iteration
`private class`	`LinkedList.Node<T>` Node data structure which the linked list refers to

Field Summary

Fields
Modifier and Type Field and Description

private LinkedList.Node<E> head

private int length

private LinkedList.Node<E> tail

Fields
Modifier and Type	Field and Description
`private LinkedList.Node<E>`	`head`
`private int`	`length`
`private LinkedList.Node<E>`	`tail`

Constructor Summary

Constructors
Constructor and Description

LinkedList()

LinkedList(E o)

Constructors
Constructor and Description
`LinkedList()`
`LinkedList(E o)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`append(E o)` Append a node containing a creature to the linked list
`LinkedList<E>`	`copy()` Make a copy of the data structure
`boolean`	`exists(E o)` Checks to see if the object o is inside the list
`int`	`getIndexOfObject(E o)` Gets the object at given index
`private LinkedList.Node<E>`	`getNodeAtIndex(int index)` Gets the node at given index
`E`	`getObjectAtIndex(int index)` Gets the object at given index
`void`	`insertAt(int index, E o)` Insert an object o into the linked list at position index.
`boolean`	`isEmpty()`
`java.util.Iterator<E>`	`iterator()` Allow the linked list to be iterable
`int`	`length()` The total number of nodes in the list
`void`	`prepend(E o)` Prepend a node containing a creature to the linked list
`boolean`	`remove(E object)`
`boolean`	`removeAt(int index)`
`LinkedList<E>`	`shallowCopy()` Make a shallow copy of the data structure, only copying the reference to each rather than create a deep copy of each
`void`	`swap(int a, int b)` Not enough time to implement this method

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - head
```
private LinkedList.Node<E> head
```
  - tail
```
private LinkedList.Node<E> tail
```
  - length
```
private int length
```
- Constructor Detail
  - LinkedList
```
LinkedList()
```
  - LinkedList
```
LinkedList(E o)
```
- Method Detail
  - prepend
```
public void prepend(E o)
```
    Prepend a node containing a creature to the linked list
    
    Parameters:
    n - A Creature reference
  - append
```
public void append(E o)
```
    Append a node containing a creature to the linked list
    
    Parameters:
    n - A Creature reference
  - isEmpty
```
public boolean isEmpty()
```
  - length
```
public int length()
```
    The total number of nodes in the list
    
    Returns:
    the length of the list
  - insertAt
```
public void insertAt(int index,
            E o)
              throws LinkedListException
```
    Insert an object o into the linked list at position index. The index must reside within the bounds of the lenth of the linked list.
    
    Parameters:
    the - location which will take the place of the new object
    the - object to insert
    
    Throws:
    
    LinkedListException
  - remove
```
public boolean remove(E object)
```
  - removeAt
```
public boolean removeAt(int index)
```
  - exists
```
public boolean exists(E o)
```
    Checks to see if the object o is inside the list
    
    Parameters:
    o - object to search for
    
    Returns:
    true if object is found, false if not
  - getNodeAtIndex
```
private LinkedList.Node<E> getNodeAtIndex(int index)
```
    Gets the node at given index
    
    Parameters:
    index - the position in the list to look for
    
    Returns:
    a node
  - getObjectAtIndex
```
public E getObjectAtIndex(int index)
```
    Gets the object at given index
    
    Parameters:
    index - the position in the list to look for
    
    Returns:
    an object
  - getIndexOfObject
```
public int getIndexOfObject(E o)
```
    Gets the object at given index
    
    Parameters:
    index - the position in the list to look for
    
    Returns:
    an object
  - copy
```
public LinkedList<E> copy()
```
    Make a copy of the data structure
    
    Returns:
    the linked list you are copying
  - shallowCopy
```
public LinkedList<E> shallowCopy()
```
    Make a shallow copy of the data structure, only copying the reference to each rather than create a deep copy of each
    
    Returns:
    A copy of the linked list
  - swap
```
public void swap(int a,
        int b)
```
    Not enough time to implement this method
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Allow the linked list to be iterable
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Returns:
    A new iterable object which can be used in for each loops

Class LinkedList<E>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

head

tail

length

Constructor Detail

LinkedList

LinkedList

Method Detail

prepend

append

isEmpty

length

insertAt

remove

removeAt

exists

getNodeAtIndex

getObjectAtIndex

getIndexOfObject

copy

shallowCopy

swap

iterator