Java Collection framework provides a Stack class that models and implements a Stack data structure. The class is based on the basic principle of last-in-first-out. In addition to the basic push and pop operations, the class provides three more functions of empty, search, and peek. The class can also be said to extend Vector and treats the class as a stack with the five mentioned functions. The class can also be referred to as the subclass of Vector. The below diagram shows the hierarchy of the Stack class:
Stack Class in Java
The class supports one default constructor Stack() which is used to create an empty stack.
Declaration:
public class Stack<E> extends Vector<E>
All Implemented Interfaces:
- Serializable: It is a marker interface that classes must implement if they are to be serialized and deserialized.
- Cloneable: This is an interface in Java which needs to be implemented by a class to allow its objects to be cloned.
- Iterable<E>: This interface represents a collection of objects which is iterable — meaning which can be iterated.
- Collection<E>: A Collection represents a group of objects known as its elements. The Collection interface is used to pass around collections of objects where maximum generality is desired.
- List<E>: The List interface provides a way to store the ordered collection. It is a child interface of Collection.
- RandomAccess: This is a marker interface used by List implementations to indicate that they support fast (generally constant time) random access.
How to Create a Stack?
In order to create a stack, we must import java.util.stack package and use the Stack() constructor of this class. The below example creates an empty Stack.
Stack<E> stack = new Stack<E>();
Here E is the type of Object.
Example:
// Java code for stack implementation
import java.io.*;
import java.util.*;
class Test
{
// Pushing element on the top of the stack
static void stack_push(Stack<Integer> stack)
{
for(int i = 0; i < 5; i++)
{
stack.push(i);
}
}
// Popping element from the top of the stack
static void stack_pop(Stack<Integer> stack)
{
System.out.println("Pop Operation:");
for(int i = 0; i < 5; i++)
{
Integer y = (Integer) stack.pop();
System.out.println(y);
}
}
// Displaying element on the top of the stack
static void stack_peek(Stack<Integer> stack)
{
Integer element = (Integer) stack.peek();
System.out.println("Element on stack top: " + element);
}
// Searching element in the stack
static void stack_search(Stack<Integer> stack, int element)
{
Integer pos = (Integer) stack.search(element);
if(pos == -1)
System.out.println("Element not found");
else
System.out.println("Element is found at position: " + pos);
}
public static void main (String[] args)
{
Stack<Integer> stack = new Stack<Integer>();
stack_push(stack);
stack_pop(stack);
stack_push(stack);
stack_peek(stack);
stack_search(stack, 2);
stack_search(stack, 6);
}
}
result:
Pop Operation:
4
3
2
1
0
Element on stack top: 4
Element is found at position: 3
Element not found
Performing various operations on Stack class
1. Adding Elements: In order to add an element to the stack, we can use the push() method. This push() operation place the element at the top of the stack.
// Java program to add the
// elements in the stack
import java.io.*;
import java.util.*;
class StackDemo {
// Main Method
public static void main(String[] args)
{
// Default initialization of Stack
Stack stack1 = new Stack();
// Initialization of Stack
// using Generics
Stack<String> stack2 = new Stack<String>();
// pushing the elements
stack1.push(4);
stack1.push("All");
stack1.push("Prutor");
stack2.push("Prutor");
stack2.push("Ai");
stack2.push("Prutor");
// Priniting the Stack Elements
System.out.println(stack1);
System.out.println(stack2);
}
}
result:
[4, All, Prutor]
[Prutor, For, Prutor]
2. Accessing the Element: To retrieve or fetch the first element of the Stack or the element present at the top of the Stack, we can use peek() method. The element retrieved does not get deleted or removed from the Stack.
// Java program to demonstrate the accessing
// of the elements from the stack
import java.util.*;
import java.io.*;
public class StackDemo {
// Main Method
public static void main(String args[])
{
// Creating an empty Stack
Stack<String> stack = new Stack<String>();
// Use push() to add elements into the Stack
stack.push("Welcome");
stack.push("To");
stack.push("Prutor");
stack.push("Ai");
stack.push("Prutor");
// Displaying the Stack
System.out.println("Initial Stack: " + stack);
// Fetching the element at the head of the Stack
System.out.println("The element at the top of the"
+ " stack is: " + stack.peek());
// Displaying the Stack after the Operation
System.out.println("Final Stack: " + stack);
}
}
result:
Initial Stack: [Welcome, To, Prutor, For, Prutor]
The element at the top of the stack is: Prutor
Final Stack: [Welcome, To, Prutor, For, Prutor]
3. Removing Elements: To pop an element from the stack, we can use the pop() method. The element is popped from the top of the stack and is removed from the same.
// Java program to demonstrate the removing
// of the elements from the stack
import java.util.*;
import java.io.*;
public class StackDemo {
public static void main(String args[])
{
// Creating an empty Stack
Stack<Integer> stack = new Stack<Integer>();
// Use add() method to add elements
stack.push(10);
stack.push(15);
stack.push(30);
stack.push(20);
stack.push(5);
// Displaying the Stack
System.out.println("Initial Stack: " + stack);
// Removing elements using pop() method
System.out.println("Popped element: "
+ stack.pop());
System.out.println("Popped element: "
+ stack.pop());
// Displaying the Stack after pop operation
System.out.println("Stack after pop operation "
+ stack);
}
}
result:
Initial Stack: [10, 15, 30, 20, 5]
Popped element: 5
Popped element: 20
Stack after pop operation [10, 15, 30]
Methods in Stack Class
empty()
It returns true if nothing is on the top of the stack. Else, returns false.
peek()
Returns the element on the top of the stack, but does not remove it.
pop()
Removes and returns the top element of the stack. An ‘EmptyStackException’
An exception is thrown if we call pop() when the invoking stack is empty.
push(Object element)
Pushes an element on the top of the stack.
search(Object element)
It determines whether an object exists in the stack. If the element is found,
It returns the position of the element from the top of the stack. Else, it returns -1.
Methods inherited from class java.util.Vector
add(Object obj) Appends the specified element to the end of this Vector.
add(int index, Object obj) Inserts the specified element at the specified position in this Vector.
addAll(Collection c)
Appends all of the elements in the specified Collection to the end of this Vector,
in the order that they are returned by the specified Collection’s Iterator.
addAll(int index, Collection c) Inserts all the elements in the specified Collection into this Vector at the specified position.
addElement(Object o) Adds the specified component to the end of this vector, increasing its size by one.
capacity() Returns the current capacity of this vector.
clear() Removes all the elements from this Vector.
clone() Returns a clone of this vector.
contains(Object o) Returns true if this vector contains the specified element.
containsAll(Collection c) Returns true if this Vector contains all the elements in the specified Collection.
copyInto(Object []array) Copies the components of this vector into the specified array.
elementAt(int index) Returns the component at the specified index.
elements() Returns an enumeration of the components of this vector.
ensureCapacity(int minCapacity)
Increases the capacity of this vector, if necessary, to ensure that it can hold
at least the number of components specified by the minimum capacity argument.
equals() Compares the specified Object with this Vector for equality.
firstElement() Returns the first component (the item at index 0) of this vector.
get(int index) Returns the element at the specified position in this Vector.
hashCode() Returns the hash code value for this Vector.
indexOf(Object o)
Returns the index of the first occurrence of the specified element in this vector, or -1
if this vector does not contain the element.
indexOf(Object o, int index)
Returns the index of the first occurrence of the specified element in this vector, searching forwards from the index, or returns -1 if the element is not found.
insertElementAt(Object o, int index) Inserts the specified object as a component in this vector at the specified index.
isEmpty() Tests if this vector has no components.
iterator() Returns an iterator over the elements in this list in proper sequence.
lastElement() Returns the last component of the vector.
lastIndexOf(Object o)
Returns the index of the last occurrence of the specified element in this vector, or -1
If this vector does not contain the element.
lastIndexOf(Object o, int index)
Returns the index of the last occurrence of the specified element in this vector,
searching backward from the index, or returns -1 if the element is not found.
listIterator() Returns a list iterator over the elements in this list (in proper sequence).
listIterator(int index)
Returns a list iterator over the elements in this list (in proper sequence),
starting at the specified position in the list.
- remove(int index) Removes the element at the specified position in this Vector.
- remove(Object o) Removes the first occurrence of the specified element in this Vector If the Vector does not contain the element, it is unchanged.
removeAll(Collection c) Removes from this Vector all of its elements that are contained in the specified Collection. - removeAllElements() Removes all components from this vector and sets its size to zero.
- removeElement(Object o) Removes the first (lowest-indexed) occurrence of the argument from this vector.
- removeElementAt(int index) Deletes the component at the specified index.
- removeRange(int fromIndex, int toIndex) Removes from this list all the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
- retainAll(Collection c) Retains only the elements in this Vector that are contained in the specified Collection.
- set(int index, Object o) Replaces the element at the specified position in this Vector with the specified element.
- setElementAt(Object o, int index) Sets the component at the specified index of this vector to be the specified object.
- setSize(int newSize) Sets the size of this vector.
- size() Returns the number of components in this vector.
- subList(int fromIndex, int toIndex) Returns a view of the portion of this List between fromIndex, inclusive, and toIndex, exclusive.
- toArray() Returns an array containing all of the elements in this Vector in the correct order.
toArray(Object []array) - Returns an array containing all of the elements in this Vector in the correct order; the runtime
type of the returned array is that of the specified array.
- toString() Returns a string representation of this Vector, containing the String representation of each element.
- trimToSize() Trims the capacity of this vector to be the vector’s current size.
- Note: Please note that the Stack class in Java is a legacy class and inherits from Vector in Java. It is a thread-safe class and hence involves overhead when we do not need thread safety. It is recommended to use ArrayDeque for stack implementation as it is more efficient in a single-threaded environment.
// A Java Program to show implementation
// of Stack using ArrayDeque
import java.util.*;
class PAI {
public static void main (String[] args) {
Deque<Character> stack = new ArrayDeque<Character>();
stack.push('A');
stack.push('B');
System.out.println(stack.peek());
System.out.println(stack.pop());
}
}
result:
B
B