Java 8 – Convert Map to List

Introduction

In Java, maps are frequently used to store key-value pairs, but sometimes you may need to convert a Map to a List. This is useful when you want to process map data in a sequential manner, perform list-specific operations, or simply extract keys or values into a list format. Java 8 introduced the Stream API, which provides a concise and efficient way to convert maps into lists. In this guide, we’ll explore how to convert a Map to different types of lists, including lists of keys, values, and entries, using various methods available in Java 8.

Table of Contents

• Problem Statement
• Solution Steps
• Java Program
  • Converting Map Keys to a List
  • Converting Map Values to a List
  • Converting Map Entries to a List of Key-Value Pairs
• Advanced Considerations
• Conclusion

Problem Statement

The task is to create a Java program that:

• Accepts a map of key-value pairs.
• Converts the map into a list based on specific criteria (keys, values, or entries).
• Outputs the resulting list.

Example 1:

• Input: Map {1: "Apple", 2: "Banana", 3: "Orange"}
• Output: List of keys [1, 2, 3]

Example 2:

• Input: Map {"Apple": 10, "Banana": 20, "Orange": 30}
• Output: List of values [10, 20, 30]

Solution Steps

1. Create a Map: Start with a map of key-value pairs.
2. Convert the Map to a List: Use the Stream API to convert the map to a list based on the desired criteria (keys, values, or entries).
3. Display the Result: Print the resulting list.

Java Program

Converting Map Keys to a List

The simplest conversion is from the map’s keys to a list. This can be done by streaming the key set and collecting it into a list.

import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

/**
 * Java 8 - Convert Map Keys to a List
 * Author: https://www.rameshfadatare.com/
 */
public class ConvertMapKeysToList {

    public static void main(String[] args) {
        // Step 1: Create a map
        Map<Integer, String> map = Map.of(
            1, "Apple",
            2, "Banana",
            3, "Orange"
        );

        // Step 2: Convert map keys to a list
        List<Integer> keysList = map.keySet()
            .stream()
            .collect(Collectors.toList());

        // Step 3: Display the result
        System.out.println("List of Keys: " + keysList);
    }
}

Output

List of Keys: [1, 2, 3]

Explanation

• The keySet() method retrieves all keys from the map.
• The stream() method creates a stream from the key set.
• The collect(Collectors.toList()) method collects the keys into a list.

Converting Map Values to a List

You can similarly convert the values of a map into a list, which is useful when you need to work with the map’s values independently of their associated keys.

import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

/**
 * Java 8 - Convert Map Values to a List
 * Author: https://www.rameshfadatare.com/
 */
public class ConvertMapValuesToList {

    public static void main(String[] args) {
        // Step 1: Create a map
        Map<String, Integer> map = Map.of(
            "Apple", 10,
            "Banana", 20,
            "Orange", 30
        );

        // Step 2: Convert map values to a list
        List<Integer> valuesList = map.values()
            .stream()
            .collect(Collectors.toList());

        // Step 3: Display the result
        System.out.println("List of Values: " + valuesList);
    }
}

Output

List of Values: [10, 20, 30]

Explanation

• The values() method retrieves all values from the map.
• The stream() method creates a stream from the values collection.
• The collect(Collectors.toList()) method collects the values into a list.

Converting Map Entries to a List of Key-Value Pairs

If you need to preserve both keys and values, you can convert the map entries into a list of Map.Entry objects.

import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.stream.Collectors;

/**
 * Java 8 - Convert Map Entries to a List of Key-Value Pairs
 * Author: https://www.rameshfadatare.com/
 */
public class ConvertMapEntriesToList {

    public static void main(String[] args) {
        // Step 1: Create a map
        Map<Integer, String> map = Map.of(
            1, "Apple",
            2, "Banana",
            3, "Orange"
        );

        // Step 2: Convert map entries to a list of key-value pairs
        List<Map.Entry<Integer, String>> entriesList = map.entrySet()
            .stream()
            .collect(Collectors.toList());

        // Step 3: Display the result
        entriesList.forEach(entry ->
            System.out.println("Key: " + entry.getKey() + ", Value: " + entry.getValue())
        );
    }
}

Output

Key: 1, Value: Apple
Key: 2, Value: Banana
Key: 3, Value: Orange

Explanation

• The entrySet() method retrieves all key-value pairs from the map as Map.Entry objects.
• The stream() method creates a stream from the entry set.
• The collect(Collectors.toList()) method collects these entries into a list.

Advanced Considerations

• Null Handling: If your map contains null values or keys, ensure your list conversion logic handles these appropriately to avoid NullPointerException.

• Order Preservation: If you need to maintain the order of keys or values as they appear in the map, consider using a LinkedHashMap when creating your map. The order in the resulting list will reflect the insertion order from the map.

• Immutability: If you need to ensure that the resulting list remains immutable, you can wrap it with Collections.unmodifiableList() after collecting the elements.

Conclusion

This guide provides methods for converting a map to a list in Java 8, covering conversions for map keys, values, and entries. Converting maps to lists is a common task when you need to process map data sequentially or perform list-specific operations. Java 8’s Stream API provides powerful and flexible tools to perform these conversions efficiently. Depending on your specific use case, you can choose the method that best fits your needs for converting maps to lists in Java.