putIfAbsent and getOrDefault Map methods with examples

In my earlier article, I had explained the Map.compute, Map.computeIfPresent and Map.computeIfAbsent methods added by Java 8. In addition, Java 8 has added two other methods called putIfAbsent and getOrDefault to the Map interface.  In this article, I will be explaining the these methods.

Edit

How putIfAbsent works

Prior to Java 8, the Map interface had a put method. This method accepts a key and a value as a parameter and adds the key-value pair to the Map. If the key passed to this method is present in the Map, its value gets overwritten with the new value. However, sometimes, we may wish to add the key-value pair only if the key is absent from the Map. The putIfAbsent method caters to such situations. Thus, it accepts a key and a value as a parameter and adds the key-value pair to the Map only if the specified key is not present in the Map. If the key is present in the Map, it does not do anything.
The following code demonstrates the put and putIfAbsent methods:

Map<Integer,String> shapesMap = new HashMap<>();shapesMap.put(1, "circle");shapesMap.put(2, "square");shapesMap.put(3, "triangle");shapesMap.put(1, "rectangle");System.out.println("Value for key 1:"+shapesMap.get(1));shapesMap.putIfAbsent(2, "pentagon");System.out.println("Value for key 2:"+shapesMap.get(2));shapesMap.putIfAbsent(4, "pentagon");System.out.println("Value for key 4:"+shapesMap.get(4));
  • Line 1 creates a Map called shapesMap which has an Integer key and a String value
  • Lines 2-4 add some values to it via the put method
  • Line 6 again invokes put with the key-value pair 1, rectangle. Since the key 1 is already present in the Map, this line overwrites its value with rectangle
  • Line 9 invokes the putIfAbsent method with 2, pentagon. Since the key 2 is already present in the Map, the putIfAbsent method does not overwrite its value.
  • Line 12 again invokes the putIfAbsent method with 4, pentagon. Since the key 4 is not present in the Map, the putIfAbsent method adds it to the map.

This code produces the following output:

Value for key 1:rectangleValue for key 2:squareValue for key 4:pentagon

How getOrDefault works

Prior to Java 8, the Map interface had a get method. This method accepts a key as a parameter and returns the value corresponding to the key. If the key passed to this method is not present in the Map, its returns a null. However, sometimes, we may wish to return a default value if the specified key is not present in the Map. The getOrDefault method caters to such situations. Thus, it accepts a key and a default value as a parameter. It returns the value corresponding to the key only if the key is present in the map. If the key is not present in the Map, it returns the specified default value.
The following code demonstrates the get and getOrDefault methods:

Map<Integer,String> shapesMap = new HashMap<>();shapesMap.put(1, "circle");shapesMap.put(2, "square");shapesMap.put(3, "triangle");System.out.println("Value for key 1:"+shapesMap.get(1));System.out.println("Value for key 5:"+shapesMap.get(5));System.out.println("Value for key 2:"+shapesMap.getOrDefault(2,"pentagon"));System.out.println("Value for key 5:"+shapesMap.getOrDefault(5,"pentagon"));
  • Line 1 creates a Map called shapesMap which has an Integer key and a String value
  • Lines 2-4 add some values to shapesMap via the put method
  • Line 6 invokes get method with the key 1. Since the key 1 is present in the Map, this returns its value that is circle
  • Line 7 invokes get method with the key 5. Since the key 5 is not present in the Map, this returns a null
  • Line 9 then invokes the getOrDefault method with the key 2 and the value pentagon. Since the key 2 is present in the Map, the getOrDefault method returns the value corresponding to 2 that is square
  • Line 10 then invokes the getOrDefault method with the key 5 and the value pentagon. Since the key 5 is not present in the Map, the getOrDefault method returns the default value that is pentagon.

This code produces the following output:

Value for key 1:circleValue for key 5:nullValue for key 2:squareValue for key 5:pentagon

Conclusion

So, in this article, we saw how the putIfAbsent and getOrDefault methods work. Just to summarize, the putIfAbsent adds the a key-value pair to the Map only if the key is absent in the Map. The getOrDefault returns the value corresponding to a key if the key is present in the Map. Otherwise, it returns a default value.

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