Java Convert List to Map Using Guava

In Java programming, there are often scenarios where you need to convert a List to a Map. While Java provides built-in ways to achieve this, Google Guava offers a more concise and powerful solution. Guava is a set of core libraries for Java that includes new collection types, immutable collections, functional types, an in-memory cache, and more. This blog post will explore how to use Guava to convert a List to a Map, including core concepts, typical usage scenarios, common pitfalls, and best practices.

Table of Contents#

  1. Core Concepts
  2. Typical Usage Scenarios
  3. Code Examples
  4. Common Pitfalls
  5. Best Practices
  6. Conclusion
  7. FAQ
  8. References

Core Concepts#

Guava provides several utility methods in the Maps class to convert a List to a Map. The most commonly used method is Maps.uniqueIndex(Iterable<? extends V> values, Function<? super V, K> keyFunction). This method takes an Iterable (such as a List) and a Function that extracts the key from each element of the Iterable. It then creates a Map where the keys are the results of applying the Function to each element, and the values are the original elements from the Iterable.

Typical Usage Scenarios#

  • Data Lookup: When you have a list of objects and need to quickly look up an object based on a specific property. For example, if you have a list of User objects and want to look up a user by their ID.
  • Grouping Data: You can use Guava to group data in a list based on a certain criteria. For instance, if you have a list of Transaction objects and want to group them by the transaction date.

Code Examples#

Example 1: Convert a List of Strings to a Map with Index as Key#

import com.google.common.collect.Maps;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
 
public class ListToMapExample {
    public static void main(String[] args) {
        // Create a list of strings
        List<String> stringList = Arrays.asList("apple", "banana", "cherry");
 
        // Convert the list to a map where the key is the index of the element in the list
        Map<Integer, String> stringMap = Maps.uniqueIndex(stringList, stringList::indexOf);
 
        // Print the map
        System.out.println(stringMap);
    }
}

In this example, we use the Maps.uniqueIndex method to convert a list of strings to a map where the key is the index of the string in the list.

Example 2: Convert a List of Custom Objects to a Map with a Property as Key#

import com.google.common.collect.Maps;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
 
class User {
    private int id;
    private String name;
 
    public User(int id, String name) {
        this.id = id;
        this.name = name;
    }
 
    public int getId() {
        return id;
    }
 
    public String getName() {
        return name;
    }
 
    @Override
    public String toString() {
        return "User{id=" + id + ", name='" + name + "'}";
    }
}
 
public class CustomObjectListToMapExample {
    public static void main(String[] args) {
        // Create a list of User objects
        List<User> userList = Arrays.asList(
                new User(1, "Alice"),
                new User(2, "Bob"),
                new User(3, "Charlie")
        );
 
        // Convert the list to a map where the key is the user ID
        Map<Integer, User> userMap = Maps.uniqueIndex(userList, User::getId);
 
        // Print the map
        System.out.println(userMap);
    }
}

In this example, we have a list of User objects. We use the Maps.uniqueIndex method to convert the list to a map where the key is the user ID.

Common Pitfalls#

  • Duplicate Keys: The Maps.uniqueIndex method requires that the keys generated by the Function are unique. If there are duplicate keys, a IllegalArgumentException will be thrown.
  • Null Keys or Values: Guava maps do not allow null keys or values. If your list contains null elements or the Function returns null keys, a NullPointerException will be thrown.

Best Practices#

  • Handle Duplicate Keys: If you expect duplicate keys in your list, you can use Multimaps.index instead of Maps.uniqueIndex. Multimaps.index allows multiple values to be associated with the same key.
  • Validate Input: Before using the Maps.uniqueIndex method, make sure that your list does not contain null elements and that the Function does not return null keys.

Conclusion#

Guava provides a convenient and powerful way to convert a list to a map in Java. By using the Maps.uniqueIndex method, you can easily create a map from a list with a custom key function. However, you need to be aware of the common pitfalls such as duplicate keys and null values. By following the best practices, you can use Guava effectively in real-world scenarios.

FAQ#

Q1: What if I have duplicate keys in my list?#

A1: If you have duplicate keys, you should use Multimaps.index instead of Maps.uniqueIndex. Multimaps.index allows multiple values to be associated with the same key.

Q2: Can I use null keys or values with Guava maps?#

A2: No, Guava maps do not allow null keys or values. If your list contains null elements or the key function returns null keys, a NullPointerException will be thrown.

References#

2025-10