craterdog.collections.interfaces

Interface LIFO<E>

Type Parameters:

E - The type of element managed by the collection.

All Known Implementing Classes:

Stack

public interface LIFO<E>

This interface defines the methods that must be implemented by each collection that supports a "last in, first out" access pattern. This pattern is usually used by a single thread to implement a stack.

Author:

Derk Norton

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.

Method Detail

pushElementOnTop

void pushElementOnTop(E element)

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

Parameters:

element - The new element to be added.

popElementOffTop

E popElementOffTop()

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

Returns:

The top element from the stack.

getTopElement

E getTopElement()

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.

Returns:

The top element on the stack.