Java ArrayDeque removeFirst() Method with Examples

---

---

Description

The Java ArrayDeque removeFirst() method retrieves and removes the first element of this deque. This operation modifies the arraydeque instance.

Declaration

Following is the declaration for java.util.ArrayDeque.removeFirst() method

public E removeFirst()

Parameters

NA

Return Value

This method returns the head (first element) of this deque.

Exception

NoSuchElementException − if this deque is empty.

Example #1

The following example shows the usage of Java ArrayDeque removeFirst() method with Integers. We're creating an ArrayDeque of Integers, adding some elements, print it and then use removeFirst() method to get the first element. As ArrayDeque is modified it is printed to check if first element is removed or not.

package com.tutorialspoint;

import java.util.ArrayDeque;

public class ArrayDequeDemo {
   public static void main(String[] args) {
      
      // create an empty array deque
      ArrayDeque<Integer> deque = new ArrayDeque<>();

      // use add() method to add elements in the deque
      deque.add(25);
      deque.add(30);
      deque.add(20);
      deque.add(18);        

      // let us print all the elements available in deque
      System.out.println("ArrayDeque = " + deque);

      // it will retrieve first element after removing from deque
      System.out.println("Retrieved Element is = " + deque.removeFirst());
	  
      // let us print all the elements available in deque again
      System.out.println("ArrayDeque = " + deque);
   }
}

Let us compile and run the above program, this will produce the following result −

ArrayDeque = [25, 30, 20, 18]
Retrieved Element is = 25
ArrayDeque = [30, 20, 18]

Example #2

The following example shows the usage of Java ArrayDeque removeFirst() method with Strings. We're creating an ArrayDeque of String, adding some elements, print it and then use removeFirst() method to get the first element. As ArrayDeque is modified it is printed to check if first element is removed or not.

package com.tutorialspoint;

import java.util.ArrayDeque;

public class ArrayDequeDemo {
   public static void main(String[] args) {
      
      // create an empty array deque
      ArrayDeque<String> deque = new ArrayDeque<>();

      // use add() method to add elements in the deque
      deque.add("A");
      deque.add("B");
      deque.add("C");
      deque.add("D");        

      // let us print all the elements available in deque
      System.out.println("ArrayDeque = " + deque);

      // it will retrieve first element after removing from deque
      System.out.println("Retrieved Element is = " + deque.removeFirst());
	  
      // let us print all the elements available in deque again
      System.out.println("ArrayDeque = " + deque);
   }
}

Let us compile and run the above program, this will produce the following result −

ArrayDeque = [A, B, C, D]
Retrieved Element is = A
ArrayDeque = [B, C, D]

Example #3

The following example shows the usage of Java ArrayDeque removeFirst() method with Student objects. We're creating an ArrayDeque of Student, adding some elements, print it and then use removeFirst() method to get the a first student removed. As ArrayDeque is modified it is printed to check if first student object is removed or not.

package com.tutorialspoint;

import java.util.ArrayDeque;

public class ArrayDequeDemo {
   public static void main(String[] args) {
      
      // create an empty array deque
      ArrayDeque<Student> deque = new ArrayDeque<>();

      // use add() method to add elements in the deque
      deque.add(new Student(1, "Julie"));
      deque.add(new Student(2, "Robert"));
      deque.add(new Student(3, "Adam"));       

      // let us print all the elements available in deque
      System.out.println("ArrayDeque = " + deque);

      // it will return true after removing first student from deque
      System.out.println("Retrieved Element is = " + deque.removeFirst());
	  
      // let us print all the elements available in deque again
      System.out.println("ArrayDeque = " + deque);
   }
}
class Student {
   int rollNo;
   String name;

   Student(int rollNo, String name){
      this.rollNo = rollNo;
      this.name = name;
   }

   @Override
   public String toString() {
      return "[ " + this.rollNo + ", " + this.name + " ]";
   }
   
   @Override
   public boolean equals(Object obj) {
      Student s = (Student)obj;
      return this.rollNo == s.rollNo && this.name.equalsIgnoreCase(s.name);
   }
}

Let us compile and run the above program, this will produce the following result −

ArrayDeque = [[ 1, Julie ], [ 2, Robert ], [ 3, Adam ]]
Retrieved Element is = [ 1, Julie ]
ArrayDeque = [[ 2, Robert ], [ 3, Adam ]]