craterdog.collections

Class Stack<E>

java.lang.Object

craterdog.collections.Stack<E>

Type Parameters:

E - The type of element managed by this collection.

All Implemented Interfaces:

Iteratable<E>, LIFO<E>, Composite, Sequential<E>, java.lang.Iterable<E>

public class Stack<E>
extends java.lang.Object
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

Constructor Summary

Constructors

Constructor and Description
Stack() This constructor creates a new empty stack.

Method Summary

Modifier and Type	Method and Description
Iterator<E>	createDefaultIterator() This method creates a new default iterator for the collection.
int	getNumberOfElements()
E	getTopElement() This method returns a reference to the top element on the stack without removing it from the stack.
boolean	isEmpty()
Iterator<E>	iterator()
E	popTopElement() This method pops the top element off of the stack.
void	pushTopElement(E element) This method pushes a new element onto the top of the stack.
void	removeAllElements() This method removes all elements from the collection.
void	toArray(E[] array)
java.lang.String	toString()
java.lang.String	toString(java.lang.String indentation)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Stack

public Stack()

This constructor creates a new empty stack.

Method Detail

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Sequential<E>

getNumberOfElements

public final int getNumberOfElements()

Specified by:

getNumberOfElements in interface Sequential<E>

createDefaultIterator

public Iterator<E> createDefaultIterator()

Description copied from interface: Iteratable

This method creates a new default iterator for the collection.

Specified by:

createDefaultIterator in interface Iteratable<E>

Returns:

A new default iterator for the collection.

toArray

public final void toArray(E[] array)

Specified by:

toArray in interface Sequential<E>

pushTopElement

public final void pushTopElement(E element)

Description copied from interface: LIFO

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

Specified by:

pushTopElement in interface LIFO<E>

Parameters:

element - The new element to be added.

popTopElement

public final E popTopElement()

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:

popTopElement in interface LIFO<E>

Returns:

The top element from the stack.

removeAllElements

public final void removeAllElements()

Description copied from interface: Iteratable

This method removes all elements from the collection.

Specified by:

removeAllElements in interface Iteratable<E>

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.

iterator

public final Iterator<E> iterator()

Specified by:

iterator in interface Sequential<E>

Specified by:

iterator in interface java.lang.Iterable<E>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.String indentation)

Specified by:

toString in interface Composite