components.linkedlist

Interface LinkedList<T>

Type Parameters:

T -

All Superinterfaces:

java.lang.Iterable<T>, LinkedListKernel<T>, Standard<LinkedList<T>>

All Known Implementing Classes:

DoublyLinkedList, LinkedList1L, LinkedListSecondary, SinglyLinkedList

public interface LinkedList<T>
extends LinkedListKernel<T>, java.lang.Iterable<T>

Additional functionality upon the bare-bones functionality afforded by the LinkedListKernel interface. All method implementations must, by design, use only the LinkedListKernel methods to perform operations on the component.

Author:

Matthew Shoemaker

Method Summary

Modifier and Type	Method and Description
boolean	contains(T entry) Reports whether this contains entry.
void	moveToPosition(int pos) Shifts this.focus to the (pos + 1)th entry in this.
T	removeFront() Removes and returns the first entry in this.
T	removeRear() Removes and returns the final entry in this.

Methods inherited from interface components.linkedlist.LinkedListKernel

add, addToFront, advance, focus, insert, length, moveToFront, moveToRear, position, remove, retreat

Methods inherited from interface components.standard.Standard

clear, newInstance, transferFrom

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

removeFront

T removeFront()

Removes and returns the first entry in this.

Returns:

the first entry in this

Updates:

this

Requires:

this.length > 0

Ensures:

          removeFront = [the first entry of #this]
          and this = [#this / front]
         

removeRear

T removeRear()

Removes and returns the final entry in this.

Returns:

the final entry in this

Updates:

this

Requires:

this.length > 0

Ensures:

          removeFront = [the final entry of #this]
          and this = #this / rear
          

contains

boolean contains(T entry)

Reports whether this contains entry.

Parameters:

entry - entry to check for in this

Returns:

boolean as to whether this contains entry

Ensures:

contains = [entry is in #this]

moveToPosition

void moveToPosition(int pos)

Shifts this.focus to the (pos + 1)th entry in this. A linked list has no index value, but this can be essentially thought of as a tool for index value in the most simple terms.

Parameters:

pos - position to which the focus will shift

Requires:

          pos < this.length and
          pos >= 0
          

Ensures:

this.position = pos