How to Work with HashMap in Java

This comprehensive guide explores Java's HashMap, a robust data structure for efficient key-value pair storage and management. We'll cover fundamental methods and provide practical examples to solidify your understanding.

---

Understanding HashMap

HashMap stores data as key-value pairs, offering (on average) constant-time complexity for core operations like put, get, and remove. Key advantages include:

• Unique Keys: Each key must be unique; values can be duplicated.
• Versatile Data Types: Keys and values can be any object type.
• Package Location: Resides within the java.util package.
• Null Handling: Accepts null as both a key and a value.

Illustrative Example:

<code class="language-java">import java.util.HashMap;

public class HashMapDemo {
    public static void main(String[] args) {
        HashMap<Integer, String> myMap = new HashMap<>();

        // Adding entries
        myMap.put(1, "Apple");
        myMap.put(2, "Banana");
        myMap.put(3, "Cherry");

        // Retrieving a value
        System.out.println(myMap.get(1)); // Output: Apple
    }
}</code>

---

HashMap Creation

The HashMap constructor is straightforward:

<code class="language-java">HashMap<KeyType, ValueType> mapName = new HashMap<>();</code>

Example:

<code class="language-java">HashMap<String, Integer> wordCounts = new HashMap<>();</code>

Here, String represents the key type and Integer the value type.

---

Essential HashMap Methods

Let's delve into frequently used HashMap methods:

1. put(K key, V value)

• Functionality: Adds a key-value pair. If the key exists, the value is updated.
• Example:

<code class="language-java">import java.util.HashMap;

public class HashMapDemo {
    public static void main(String[] args) {
        HashMap<Integer, String> myMap = new HashMap<>();

        // Adding entries
        myMap.put(1, "Apple");
        myMap.put(2, "Banana");
        myMap.put(3, "Cherry");

        // Retrieving a value
        System.out.println(myMap.get(1)); // Output: Apple
    }
}</code>

---

2. get(Object key)

• Functionality: Retrieves the value associated with the given key. Returns null if the key is absent.
• Example:

<code class="language-java">HashMap<KeyType, ValueType> mapName = new HashMap<>();</code>

---

3. getOrDefault(Object key, V defaultValue)

• Functionality: Retrieves the value; if the key is missing, returns the defaultValue.
• Example:

<code class="language-java">HashMap<String, Integer> wordCounts = new HashMap<>();</code>

---

4. containsKey(Object key)

• Functionality: Checks if the map contains the specified key.
• Example:

<code class="language-java">HashMap<Integer, String> myMap = new HashMap<>();
myMap.put(1, "Apple");
myMap.put(2, "Banana");
myMap.put(1, "Orange"); // Updates value for key 1
System.out.println(myMap); // Output: {1=Orange, 2=Banana}</code>

---

5. containsValue(Object value)

• Functionality: Checks if the map contains the specified value.
• Example:

<code class="language-java">System.out.println(myMap.get(1)); // Output: Orange
System.out.println(myMap.get(4)); // Output: null</code>

---

6. remove(Object key)

• Functionality: Removes the entry for the given key and returns its value (or null if not found).
• Example:

<code class="language-java">System.out.println(myMap.getOrDefault(4, "Default")); // Output: Default</code>

---

7. putIfAbsent(K key, V value)

• Functionality: Adds the key-value pair only if the key doesn't already exist.
• Example:

<code class="language-java">System.out.println(myMap.containsKey(1)); // Output: true
System.out.println(myMap.containsKey(4)); // Output: false</code>

---

8. replace(K key, V value)

• Functionality: Replaces the value for the key only if the key exists.
• Example:

<code class="language-java">System.out.println(myMap.containsValue("Orange")); // Output: true
System.out.println(myMap.containsValue("Grape")); // Output: false</code>

---

9. keySet()

• Functionality: Returns a Set of all keys in the map.
• Example:

<code class="language-java">System.out.println(myMap.remove(1)); // Output: Orange
System.out.println(myMap); // Output: {2=Banana}</code>

---

10. values()

• Functionality: Returns a Collection of all values in the map.
• Example:

<code class="language-java">myMap.putIfAbsent(3, "Cherry"); // No change if key 3 exists
System.out.println(myMap);</code>

---

11. entrySet()

• Functionality: Returns a Set of all key-value pairs (Map.Entry).
• Example:

<code class="language-java">myMap.replace(2, "Mango");
System.out.println(myMap);</code>

---

12. compute(K key, BiFunction remappingFunction)

• Functionality: Updates the value using a provided function.
• Example: (Requires a BiFunction implementation)

<code class="language-java">import java.util.HashMap;

public class HashMapDemo {
    public static void main(String[] args) {
        HashMap<Integer, String> myMap = new HashMap<>();

        // Adding entries
        myMap.put(1, "Apple");
        myMap.put(2, "Banana");
        myMap.put(3, "Cherry");

        // Retrieving a value
        System.out.println(myMap.get(1)); // Output: Apple
    }
}</code>

---

13. merge(K key, V value, BiFunction remappingFunction)

• Functionality: Combines a new value with the existing value using a function.
• Example: (Requires a BiFunction implementation)

<code class="language-java">HashMap<KeyType, ValueType> mapName = new HashMap<>();</code>

---

Comprehensive Example: Word Frequency Analysis

This example showcases HashMap for counting word frequencies:

<code class="language-java">HashMap<String, Integer> wordCounts = new HashMap<>();</code>

---

Conclusion

HashMap is a fundamental Java data structure, offering efficient key-value pair management. Mastering its methods empowers you to tackle diverse programming challenges, from simple data lookups to sophisticated data manipulation tasks. Incorporate HashMap into your projects to harness its power and efficiency.

The above is the detailed content of How to Work with HashMap in Java. For more information, please follow other related articles on the PHP Chinese website!