speiger.src.collections.utils

Interface Stack<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Known Implementing Classes:

CopyOnWriteObjectArrayList, ObjectArrayList, ObjectLinkedList

public interface Stack<T>

The Stack Interface represents the Last-In-First-Out layout (LIFO). It provides a simple push(Object), pop() function, with a fast clear() function. The peek(int) function allows to view the contents of the stack (top to bottom).

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the stack
default boolean	isEmpty()
T	peek(int index) Provides the Selected Object from the stack.
T	pop() Removes the Object on top of the stack.
void	push(T e) Inserts a given Object on top of the stack
int	size() Provides the amount of elements currently in the stack
default T	top() Provides the Object on top of the stack

Method Detail

push

void push(T e)

Inserts a given Object on top of the stack

Parameters:

e - the Object to insert

pop

T pop()

Removes the Object on top of the stack.

Returns:

the element that is on top of the stack

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the stack is empty

size

int size()

Provides the amount of elements currently in the stack

Returns:

amount of elements in the list

isEmpty

default boolean isEmpty()

Returns:

if the stack is empty

clear

void clear()

Clears the stack

top

default T top()

Provides the Object on top of the stack

Returns:

the element that is on top of the stack

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the stack is empty

peek

T peek(int index)

Provides the Selected Object from the stack. Top to bottom

Parameters:

index - of the element that should be provided

Returns:

the element that was requested

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the index is out of bounds