Java Queue Interface Methods Explained With Code Samples

One of the lesser known Collection interfaces in the java.util.Queue interface. In this article, I will be covering this interface in detail.

What is the Java Queue interface?

The java.util.Queue interface extends the java.util.Collection interface. It provides a First In First Out (FIFO) behavior and you can use it to represent a Queue data structure.  It has several implementations in the Collection API. The java.util.LinkedList and java.util.PriorityQueue are the most common implementations

Java Queue Interface Operations

There are several methods available on the queue interface that help to perform various queue operations.

add

The addmethod supports adding an element to the Queue. if for some reason the add method is unable to add the element, it throws an Exception.

Sample Code (Without Exception)

Queue<String> daysOfTheWeek = new LinkedList<String>();daysOfTheWeek.add("Monday");daysOfTheWeek.add("Tuesday");daysOfTheWeek.add("Wednesday");System.out.println(daysOfTheWeek);
  • Line 1 creates a daysOfTheWeek queue. It uses the LinkedList implementation
  • Lines 2-4 use the add method to add some values to the queue
  • Line 6 prints the queue.

Output

[Monday, Tuesday, Wednesday]

Sample Code (With Exception)

As mentniod earlier, if the add method is unable to add the element, it throws an Exception. This behaviour is not evident when you use the LinkedList implementation of a Queue. However it is evident for the ArrayBlockingQueue implementation which has a capacity restriction.

	        Queue<String> daysOfTheWeek = new ArrayBlockingQueue<String>(1); 		boolean added = daysOfTheWeek.add("Monday"); 		System.out.println(added);		added = daysOfTheWeek.add("Tuesday"); 		System.out.println(added);
  • Line 1 creates a daysOfTheWeek queue. It uses the ArrayBlockingQueue implementation and specifies the size as 1
  • Line 2 uses the add method to add the value Monday which returns true
  • Line 4 uses the add method to add the value Tuesday 
  • Since this is a Queue with size 1, Line 4 causes an exception.

Output:

trueException in thread "main" java.lang.IllegalStateException: Queue fullat java.base/java.util.AbstractQueue.add(AbstractQueue.java:98)at java.base/java.util.concurrent.ArrayBlockingQueue.add(ArrayBlockingQueue.java:326)at demo.QueueDemo.main(QueueDemo.java:14)

offer

The offer method is similar to add.  So it adds an element at the head of the queue . The only difference is if for some reason the  offer method is unable to add an element to the queue, it returns a false.

Sample Code

Queue<String> daysOfTheWeek = new ArrayBlockingQueue<String>(1); boolean added = daysOfTheWeek.offer("Monday"); System.out.println("Added Monday:"+added);added = daysOfTheWeek.offer("Tuesday"); System.out.println("Added Tuesday:"+added);
  • Line 1 creates a daysOfTheWeek queue. It uses the ArrayBlockingQueue implementation and specifies the size as 1
  • Lines 2 uses the offer method to add the value Monday which returns true
  • Lines 4 uses the offer method to add the value Monday which returns false since the queue is full

Output:

Added Monday:trueAdded Tuesday:false

remove

The removemethods helps removing a value from a Queue. It removes the element at the head of the queue. If the queue is empty, it throws a NoSuchElementException

Sample Code (Non-empty Queue)

Queue<String> daysOfTheWeek = new LinkedList<String>();daysOfTheWeek.add("Monday");daysOfTheWeek.add("Tuesday");daysOfTheWeek.add("Wednesday");String day = daysOfTheWeek.remove();System.out.println(day);
  • Line 1 creates a daysOfTheWeek queue. It uses the LinkedList implementation
  • Lines 2-4 use the add method to add some values to the queue
  • Line 5 uses the remove method to remove the head of the queue, in this case Monday
  • Line 6 prints the removed value

Output:

Monday

Sample Code (Empty Queue)

As mentioned earlier, when you invoke removeon an empty queue, it throws a NoSuchElementException

Queue<String> daysOfTheWeek = new LinkedList<String>(); String day = daysOfTheWeek.remove(); System.out.println(day);
  • Line 1 creates a daysOfTheWeek queue. It uses the LinkedList implementation
  • Line 2 invokes the remove method
  • Since the Queue is empty, it causes a NoSuchElementException

Output:

Exception in thread "main" java.util.NoSuchElementExceptionat java.base/java.util.LinkedList.removeFirst(LinkedList.java:274)at java.base/java.util.LinkedList.remove(LinkedList.java:689)at demo.QueueDemo.main(QueueDemo.java:11)

poll

The pollmethod is similar to remove. So it removes the element at the head of the queue. The only difference is that if the queue is empty, the pollmethod returns a null. The removemethod on the other hand throws a NoSuchElementException .

Sample Code:

Queue<String> daysOfTheWeek = new LinkedList<String>();daysOfTheWeek.add("Monday");String day = daysOfTheWeek.poll();System.out.println(day);day = daysOfTheWeek.poll();System.out.println(day);
  • Line 1 creates a daysOfTheWeek queue. It uses the LinkedList implementation
  • Lines 2 uses the add method to add the value Monday to the queue
  • Line 3 uses the poll method to remove the head of the queue, in this case Monday
  • Line 4 again invokes the poll method which returns a null since the queue is empty

Output:

Mondaynull

element

The elementmethod returns the head of the queue but does not remove it from the queue. It throws a NoSuchElementException if the queue is empty.

Sample Code:

		Queue<String> daysOfTheWeek = new LinkedList<String>(); 		daysOfTheWeek.add("Monday"); 		String day = daysOfTheWeek.element(); 		System.out.println(day); 		day = daysOfTheWeek.element(); 		System.out.println(day);				daysOfTheWeek = new LinkedList<String>(); 		day = daysOfTheWeek.element(); 		System.out.println(day);
  • Line 1 creates a daysOfTheWeek queue. It uses the LinkedList implementation
  • Lines 2 uses the add method to add the value Monday to the queue
  • Line 3 uses the element method to retrieve the head of the queue, in this case Monday. It does not remove this value from the queue
  • Line 5 again uses the element method again to retrieve the head of the queue. Since the call at Line 3 does not remove the value, this call also returns Monday
  • Line 8 initializes the daysOfTheWeek Queue to a new empty Queue
  • Line 9 uses the element method to retrieve the head of the queue
  • Since the queue is empty, this causes a NoSuchElementException

Output:

MondayMondayException in thread "main" java.util.NoSuchElementExceptionat java.base/java.util.LinkedList.getFirst(LinkedList.java:248)at java.base/java.util.LinkedList.element(LinkedList.java:667)at demo.QueueDemo.main(QueueDemo.java:18)

peek

The peekmethod is similar to element. So it returns the element at the head of the queue without removing it. The only difference is that if the queue is empty, the peekmethod returns a null. The elementmethod on the other hand throws a NoSuchElementException.

Sample Code:

Queue<String> daysOfTheWeek = new LinkedList<String>();daysOfTheWeek.add("Monday");String day = daysOfTheWeek.peek();System.out.println(day);daysOfTheWeek = new LinkedList<String>();day = daysOfTheWeek.peek();System.out.println(day);
  • Line 1 creates a daysOfTheWeek queue. It uses the LinkedList implementation
  • Lines 2 uses the add method to add the value Monday to the queue
  • Line 4 uses the peek method to retrieve the head of the queue, in this case Monday. It does not remove this value from the queue
  • Line 7 initializes the daysOfTheWeek Queue to a new empty Queue
  • Line 9 uses the element method to retrieve the head of the queue
  • Since the queue is empty,it returns null

Output:

Mondaynull

Conclusion

So in this article, we understood the java.util.Queue interface. We also saw the various operations like peek, poll, add, remove and element on the Queue interface.

Comments

Post a Comment

Popular posts from this blog

How to use logging in SpringBoot with code samples

Image
In this article, we will learn how to use logging in SpringBoot. Introduction There are several Java logging frameworks like logback, log4j, and so on. Spring Boot supports out-of-the-box support for logback. Let us learn how to use logging in SpringBoot with logback. Step 1 – Create a New Maven Project Create a new Maven project. (Refer to  this  blog post). This will create a project in Eclipse as follows:   Step 2 – Add the Spring Boot Dependencies Add the spring-boot-starter-web dependency to the pom.xml . So, the pom.xml should look as follows: <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.learnjava</groupId> <artifactId>learnjava-springboot-logging-example</artifactId> <version>0.0.1-SNAPSHOT&
Read more

Python While Loop with code samples

Much like a Java while loop, you can use a Python while loop to repeatedly execute a block of code as long as a condition is true. In this article, we will learn more about the Python while loop. Python While loop Syntax A while loop in Python has the following syntax: while <condition>: loop body The while keyword is followed by a condition. If the condition evaluates to true, the body of the loop is executed. Once the body of the loop is completed, the condition is checked again and this is repeated until the condition evaluates to false at which point the loop is exited. While loop Sample Code The following code demonstrates how you can use the while loop: num=10counter=1total=0while counter<=num: total += counter counter+=1print("sum of first 10 numbers is",total) This code adds the numbers from 1 to 10 and prints the sum. It uses a while loop to iterate from 1 to 10. The while loop checks the condition counter <= num and if so adds the current value of count
Read more

How to convert a List to a Set

In this blog post ,I will be showing you how you can convert a List to a Set. Consider the following code snippet: public class ListToSetDemo {public static void main(String[] args) {List<Integer> list = Arrays.asList(5,3,11,15,9);//Method 1Set<Integer> set = new HashSet<Integer>(list);System.out.println("Set is "+set);//method 2Set<Integer> set2 = new HashSet<Integer>();set2.addAll(list);System.out.println("Set is "+set2);}} This code demonstrates two ways to convert a List to a Set. Method 1 Here, we are creating a new HashSet . We are invoking the constructor that accepts a Collection object. Here, we are passing in the input list to this constructor.   Method 2 Here again, we are creating a new HashSet . However, we are using the default constructor. We are then invoking the addAll method and passing in the input list.   When you run this code, it will print the following output: Set is [3, 5, 9, 11, 15]Set is [3, 5, 9, 11, 15] No
Read more