speiger.src.collections.chars.collections

Interface CharStack

All Known Implementing Classes:

CharArrayList, CharLinkedList, CopyOnWriteCharArrayList

public interface CharStack

A Type-Specific Stack that reduces (un)boxing

Method Summary

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

Method Detail

push

void push(char e)

Inserts a given Object on top of the stack

Parameters:

e - the Object to insert

See Also:

Stack.push(Object)

pop

char 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

See Also:

Stack.pop()

top

default char 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

See Also:

Stack.top()

peek

char 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

See Also:

Stack.peek(int)

clear

void clear()

Clears the stack

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