craterdog.collections

Class Stack<E>

java.lang.Object

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.ClosedCollection<E>

craterdog.collections.Stack<E>

Type Parameters:

E - The type of element managed by this collection.

All Implemented Interfaces:

Accessible<E>, LIFO<E>, Composite, Sequential<E>, java.lang.Comparable<Collection<E>>, java.lang.Iterable<E>

public class Stack<E>
extends ClosedCollection<E>
implements LIFO<E>

This collection class implements a stack (LIFO) data structure. Attempting to access an entity on an empty stack is considered a bug in the calling code and a runtime exception is thrown. The implementation dynamically scales up and down the size of the underlying data structures as the number elements changes over time.

Author:

Derk Norton

Field Summary

Fields inherited from class craterdog.collections.abstractions.ClosedCollection

list

Constructor Summary

Constructors

Constructor and Description
Stack() This constructor creates a new stack of unlimited capacity.
Stack(int capacity) This constructor creates a new stack with the specified capacity.

Method Summary

Modifier and Type	Method and Description
E	getTopElement() This method returns a reference to the top element on the stack without removing it from the stack.
E	popElementOffTop() This method pops the top element off of the stack.
void	pushElementOnTop(E element) This method pushes a new element onto the top of the stack.

Methods inherited from class craterdog.collections.abstractions.ClosedCollection

createDefaultIterator, getElementAtIndex, getElementsInRange, getIndexOfElement, getNumberOfElements, removeAllElements

Methods inherited from class craterdog.collections.abstractions.Collection

compareTo, containsAllElementsIn, containsAnyElementsIn, containsElement, equals, hashCode, isEmpty, iterator, normalizedIndex, toArray, toArray, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Stack

public Stack()

This constructor creates a new stack of unlimited capacity.

Stack

public Stack(int capacity)

This constructor creates a new stack with the specified capacity.

Parameters:

capacity - The maximum number of elements that can be on the stack at one time.

Method Detail

pushElementOnTop

public final void pushElementOnTop(E element)

Description copied from interface: LIFO

This method pushes a new element onto the top of the stack.

Specified by:

pushElementOnTop in interface LIFO<E>

Parameters:

element - The new element to be added.

popElementOffTop

public final E popElementOffTop()

Description copied from interface: LIFO

This method pops the top element off of the stack. If the stack is empty an exception is thrown.

Specified by:

popElementOffTop in interface LIFO<E>

Returns:

The top element from the stack.

getTopElement

public final E getTopElement()

Description copied from interface: LIFO

This method returns a reference to the top element on the stack without removing it from the stack. If the stack is empty an exception is thrown.

Specified by:

getTopElement in interface LIFO<E>

Returns:

The top element on the stack.