Interface StackInterface<E>

Type Parameters:

E - The type of Object that the stack will accept.

All Superinterfaces:

java.lang.Iterable<E>

All Known Implementing Classes:

ArrayBasedStack, LinkedStack

public interface StackInterface<E>
extends java.lang.Iterable<E>

Generic interface for a LIFO stack.

Author:

Sameh Fakhouri

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all elements from the stack.
boolean	isEmpty() This method is called to determine if the stack is empty.
E	peek() Retrieves, but does not remove, the top of the stack.
E	pop() Retrieves and removes the element at the top of the stack.
void	push(E e) Pushed the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, otherwise, throwing an IllegalStateException if no space is currently available or NullPointerException if the specified element is null.
int	size() This method is called to obtain the count of elements in the stack.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

isEmpty

boolean isEmpty()

This method is called to determine if the stack is empty.

Returns:

Returns true if the stack is empty, otherwise it returns false.

size

int size()

This method is called to obtain the count of elements in the stack.

Returns:

Returns the numbers of elements that are currently in the stack.

push

void push(E e)
   throws java.lang.IllegalStateException,
          java.lang.NullPointerException

Pushed the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, otherwise, throwing an IllegalStateException if no space is currently available or NullPointerException if the specified element is null.

Parameters:

e - The element to add.

Throws:

java.lang.IllegalStateException - If the element cannot be added at this time due to capacity restrictions.

java.lang.NullPointerException - If the specified element being added is null.

peek

E peek()

Retrieves, but does not remove, the top of the stack.

Returns:

The element at the top of the stack or null if the stack is empty.

pop

E pop()

Retrieves and removes the element at the top of the stack.

Returns:

The element at the top of the stack or null if the queue is empty.

clear

void clear()

Removes all elements from the stack.