LinkedList pollFirst() method - Syntax and Examples

Learn about the Java LinkedList's `pollFirst()` method. This tutorial explains its syntax, parameters, return value, and provides practical examples.

This reference explains LinkedList pollFirst() method - Syntax and Examples through its syntax, examples and boundaries. Use the linked course lessons when the surrounding Java concepts are unfamiliar.

The pollFirst() method in Java's LinkedList class is a powerful tool for managing the order of elements. It retrieves and removes the first element from the linked list. If the list is empty, it returns null instead of throwing an exception (unlike removeFirst()).

public E pollFirst()

This example demonstrates how to use pollFirst() to remove the first element from a linked list. We create a LinkedList, add some elements, then retrieve and remove the first one using pollFirst().

import java.util.LinkedList;

public class PollFirstExample1 {
    public static void main(String[] args) {
        LinkedList<String> list = new LinkedList<>();
        list.add("Apple");
        list.add("Banana");
        list.add("Cherry");

        System.out.println("Original List: " + list);

        String firstElement = list.pollFirst();

        System.out.println("Removed First Element: " + firstElement);
        System.out.println("List after removing first element: " + list);
    }
}

Original List: [Apple, Banana, Cherry]
Removed First Element: Apple
List after removing first element: [Banana, Cherry]

In this example, pollFirst() removed "Apple" from the beginning of the list and returned it. The remaining elements are now in the list.

This example showcases what happens when you call pollFirst() on an empty linked list. It demonstrates that instead of throwing an exception, pollFirst() simply returns null.

import java.util.LinkedList;

public class PollFirstExample2 {
    public static void main(String[] args) {
        LinkedList<Integer> list = new LinkedList<>(); // Empty List

        System.out.println("Original List: " + list);

        Integer firstElement = list.pollFirst();

        System.out.println("Removed First Element: " + firstElement);  // Will print null
        System.out.println("List after attempting to remove first element: " + list); // Remains empty.
    }
}

Original List: []
Removed First Element: null
List after attempting to remove first element: []

Since the list was initially empty, pollFirst() returned null. The list remains unchanged.

This example shows how to use pollFirst() in a loop to process elements from the front of the LinkedList until it's empty.

import java.util.LinkedList;

public class PollFirstExample3 {
    public static void main(String[] args) {
        LinkedList<Double> list = new LinkedList<>();
        list.add(1.0);
        list.add(2.5);
        list.add(3.7);

        System.out.println("Original List: " + list);

        while (list != null && !list.isEmpty()) {
            Double element = list.pollFirst();
            System.out.println("Processing: " + element);
        }

        System.out.println("List after processing: " + list); // Should be empty.
    }
}

Original List: [1.0, 2.5, 3.7]
Processing: 1.0
Processing: 2.5
Processing: 3.7
List after processing: []

The loop continues as long as the list is not empty and contains elements to process. Each iteration retrieves and removes the first element, prints it, and then repeats until the list becomes empty.

Check the example’s types, inputs and documented behavior before copying it into an application. Some APIs require external libraries, files or platform services; consult their setup notes.

Related explanations: Java Data Types - Primitive and Non-Primitive, Java Class - Blueprint of Objects, Exceptions in Java Introduction.

Supporting documentation: Official Java learning guide.