structure5
Class StackList<E>

java.lang.Object
  structure5.AbstractStructure<E>
      structure5.AbstractLinear<E>
          structure5.AbstractStack<E>
              structure5.StackList<E>

All Implemented Interfaces:

java.lang.Iterable<E>, Linear<E>, Stack<E>, Structure<E>

public class StackList<E>
extends AbstractStack<E>
implements Stack<E>

An implementation of a stack, based on lists. The head of the stack is stored at the head of the list, allowing the stack to grow and shrink in constant time. This stack implementation is ideal for applications that require a dynamically resizable stack that expands in constant time.

Example usage:

To reverse a string, we would use the following:

 public static void main(String[] arguments)
 {
     if(arguments.length > 0){
         StackList reverseStack = new StackList();
         String s = arguments[0];
          
         for(int i=0; i < s.length(); i++){
             reverseStack.push(new Character(s.charAt(i)));
         }

         while(!reverseStack.empty()){
             System.out.print(reverseStack.AbstractStack.pop());
         }

         System.out.println();
     }
 }
 

See Also:

Stack, StackVector, StackArray, AbstractStack

Field Summary

protected List<E>

data The list that maintains the stack data.

Constructor Summary

StackList()
Construct an empty stack.

Method Summary

void	add(E value) Add a value to the top of the stack.
void	clear() Remove all elements from the stack.
boolean	empty() Determine if the stack is empty.
E	get() Get a reference to the top value in the stack.
java.util.Iterator<E>	iterator() Returns an iterator for traversing the structure.
E	remove() Remove a value from the top of the stack.
int	size() Determine the number of elements in the stack.
java.lang.String	toString() Construct a string representation of the stack.

Methods inherited from class structure5.AbstractStack

getFirst, peek, pop, push

Methods inherited from class structure5.AbstractLinear

remove

Methods inherited from class structure5.AbstractStructure

contains, elements, hashCode, isEmpty, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface structure5.Stack

getFirst, peek, pop, push

Methods inherited from interface structure5.Structure

contains, elements, isEmpty, remove, values

Field Detail

data

protected List<E> data

The list that maintains the stack data.

Constructor Detail

StackList

public StackList()

Construct an empty stack.

Postcondition:

constructs a new stack, based on lists

Method Detail

clear

public void clear()

Remove all elements from the stack.

Specified by:

clear in interface Structure<E>

Postcondition:

removes all elements from stack

empty

public boolean empty()

Determine if the stack is empty. Provided for compatibility with java.util.Stack.empty.

Specified by:

empty in interface Linear<E>

Specified by:

empty in interface Stack<E>

Overrides:

empty in class AbstractLinear<E>

Returns:

True iff the stack is empty.

See Also:

AbstractStructure.isEmpty()

Postcondition:

returns true iff the stack is empty

iterator

public java.util.Iterator<E> iterator()

Description copied from interface: Structure

Returns an iterator for traversing the structure.

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface Structure<E>

Returns:

an iterator for traversing the structure

See Also:

AbstractIterator, Iterator, Enumeration, Structure.elements()

get

public E get()

Get a reference to the top value in the stack.

Specified by:

get in interface Linear<E>

Specified by:

get in interface Stack<E>

Returns:

A reference to the top element of the top of the stack.

Precondition:

stack is not empty

Postcondition:

returns the top element (most recently pushed) from stack

add

public void add(E value)

Add a value to the top of the stack.

Specified by:

add in interface Linear<E>

Specified by:

add in interface Stack<E>

Specified by:

add in interface Structure<E>

Parameters:

item - The value to be added.

See Also:

AbstractStack.push(E)

Postcondition:

adds an element to stack; will be next element popped if no intervening push

remove

public E remove()

Remove a value from the top of the stack.

Specified by:

remove in interface Linear<E>

Specified by:

remove in interface Stack<E>

Returns:

The value removed from the top of the stack.

See Also:

AbstractStack.pop()

Precondition:

stack is not empty

Postcondition:

removes and returns the top element from stack

size

public int size()

Determine the number of elements in the stack.

Specified by:

size in interface Linear<E>

Specified by:

size in interface Stack<E>

Specified by:

size in interface Structure<E>

Returns:

The number of values within the stack.

Postcondition:

returns the size of the stack

toString

public java.lang.String toString()

Construct a string representation of the stack.

Overrides:

toString in class java.lang.Object

Returns:

A string representing the stack.

Postcondition:

returns a string representation of stack