$show=/label

Optional ofNullable() method (With Examples)

SHARE:

A quick guide to Optional ofNullable() method in Java 8 API with Example programs. How to use in the real time projects.

1. Introduction


In this tutorial, We'll learn Optional ofNullable() example on how to create new Java 8 Optional object for any value or null value. Optional is part of java.util package.

Java 8 Optional ofNullable() Method Example


API Note: Returns an Optional describing the given value, if non-null, otherwise returns an empty Optional.


This method same as Optional.of() method and additionally supports null values. It does not throw NullPointerException if we pass null to it.

If we are not sure about the value then using ofNullable() method is suggestable.
Let us see the syntax and example programs.

2. Optional ofNullable Syntax

ofNullable syntax is below.

public static <T> Optional<T> ofNullable(T value)

ofNullable() is a static method and can be accessed directly with the class name. ofNullable() returns Optional object.
This method accepts any type of value.

3. Java 8 ofNullable() Example


Let us write an example java program on ofNullable().

package com.java.w3schools.blog.java8.optional;

import java.util.Optional;

/**
 * Java 8 Optional ofNullable() Method Example
 * 
 * @author Venkatesh
 *
 */
public class OptionalOfNullableExample {

 public static void main(String[] args) {

  // A non-null value is passed
  Optional<String> indiaOptional = Optional.ofNullable(getValue("India"));
  System.out.println("indiaOptional : " + indiaOptional);

  // A null value is passed
  Optional<String> usOptional = Optional.ofNullable(getValue("United States"));
  System.out.println("usOptional : " + usOptional);

  System.out.println(indiaOptional.isPresent());
  System.out.println(usOptional.isPresent());
 }

 private static String getValue(String key) {

  if ("India".equals(key)) {
   return "Delhi";
  } else if ("Australia".equals(key)) {
   return "Sidney";
  }

  return null;
 }

}

Output:

indiaOptional : Optional[Delhi]
usOptional : Optional.empty

Assume that getValue() is a third party API method and we do not know the value returns. The returned value may be null or non-null. In such cases, We should use ofNullable() instead of of() method.

In the output, We are seeing the value for the indiaOptional as Delhi. But, seeing Optional.empty for usOptional. Because ofNullable method internally calls Optional.empty() method if the null value is passed to it.

Internal Implementation Code:


See the internal logic to understand how it is implemented. This method uses two methods. If the value is null, it calls empty() method. If the value is non-null, it calls of() method.

public static <T> Optional<T> ofNullable(T value) {
    return value == null ? empty() : of(value);
}

Let us take a look at the below example to check value is present using isPresent() method.

System.out.println(indiaOptional.isPresent());
System.out.println(usOptional.isPresent());

Output:

true
false

If you use of() method, it will throw NullPointerException.

4. Conclusion


In this article, We've seen how to create an Optional object for any nullable or non-null value. This method also is a static method as empty() and of() methods of Optional class. This will not throw any runtime exception for any value.

An example scenario where to use ofNullable() method.

And also seen its internal implementation logic.

Full example code on GitHub
API ref

COMMENTS

BLOGGER

About Us

Author: Venkatesh - I love to learn and share the technical stuff.
Name

accumulo,1,ActiveMQ,2,Adsense,1,API,37,ArrayList,16,Arrays,7,Bean Creation,3,Bean Scopes,1,BiConsumer,1,Blogger Tips,1,Books,1,C Programming,1,Collection,5,Collections,22,Collector,1,Command Line,1,Compile Errors,1,Configurations,7,Constants,1,Control Statements,8,Conversions,6,Core Java,81,Corona India,1,Create,2,CSS,1,Date,3,Date Time API,4,Dictionary,1,Difference,1,Download,1,Eclipse,2,Efficiently,1,Error,1,Errors,1,Exception,1,Exceptions,3,Fast,1,Files,9,Float,1,Font,1,Form,1,Freshers,1,Function,3,Functional Interface,2,Garbage Collector,1,Generics,4,Git,4,Grant,1,Grep,1,HashMap,1,HomeBrew,2,HTML,2,HttpClient,2,Immutable,1,Installation,1,Interview Questions,5,Iterate,2,Jackson API,3,Java,29,Java 10,1,Java 11,5,Java 12,5,Java 13,2,Java 14,2,Java 8,66,Java 8 Difference,2,Java 8 Stream Conversions,2,java 8 Stream Examples,3,Java 9,1,Java Conversions,11,Java Design Patterns,1,Java Files,1,Java Program,2,Java Programs,65,java.lang,5,java.util. function,1,jQuery,1,Kotlin,10,Kotlin Conversions,3,Kotlin Programs,6,Lambda,1,lang,29,Leap Year,1,live updates,1,Logging,1,Mac OS,2,Math,1,Maven,1,Method References,1,Mockito,1,MongoDB,3,New Features,1,Operations,1,Optional,6,Oracle,5,Oracle 18C,1,Partition,1,Patterns,1,Programs,1,Property,1,Python,2,Quarkus,1,Read,1,Real Time,1,Recursion,2,Remove,2,Rest API,1,Schedules,1,Serialization,1,Servlet,1,Sort,1,Sorting Techniques,8,Spring,2,Spring Boot,23,Spring Email,1,Spring MVC,1,Streams,21,String,58,String Programs,9,String Revese,1,Swing,1,System,1,Tags,1,Threads,10,Tomcat,1,Tomcat 8,1,Troubleshoot,16,Unix,2,Updates,3,util,5,While Loop,1,
ltr
item
JavaProgramTo.com: Optional ofNullable() method (With Examples)
Optional ofNullable() method (With Examples)
A quick guide to Optional ofNullable() method in Java 8 API with Example programs. How to use in the real time projects.
https://1.bp.blogspot.com/-60BXdZfo66E/XUG31Z4CwCI/AAAAAAAAByU/JUIeOoHdqT49cKKEyoxPz-CTlcgOQnEvgCLcBGAs/s640/Java%2B8%2BOptional%2BofNullable%2528%2529%2BMethod%2BExample.png
https://1.bp.blogspot.com/-60BXdZfo66E/XUG31Z4CwCI/AAAAAAAAByU/JUIeOoHdqT49cKKEyoxPz-CTlcgOQnEvgCLcBGAs/s72-c/Java%2B8%2BOptional%2BofNullable%2528%2529%2BMethod%2BExample.png
JavaProgramTo.com
https://www.javaprogramto.com/2020/05/java-8-optional-ofnullable.html
https://www.javaprogramto.com/
https://www.javaprogramto.com/
https://www.javaprogramto.com/2020/05/java-8-optional-ofnullable.html
true
3124782013468838591
UTF-8
Loaded All Posts Not found any posts VIEW ALL Readmore Reply Cancel reply Delete By Home PAGES POSTS View All RECOMMENDED FOR YOU LABEL ARCHIVE SEARCH ALL POSTS Not found any post match with your request Back Home Sunday Monday Tuesday Wednesday Thursday Friday Saturday Sun Mon Tue Wed Thu Fri Sat January February March April May June July August September October November December Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec just now 1 minute ago $$1$$ minutes ago 1 hour ago $$1$$ hours ago Yesterday $$1$$ days ago $$1$$ weeks ago more than 5 weeks ago Followers Follow THIS PREMIUM CONTENT IS LOCKED STEP 1: Share to a social network STEP 2: Click the link on your social network Copy All Code Select All Code All codes were copied to your clipboard Can not copy the codes / texts, please press [CTRL]+[C] (or CMD+C with Mac) to copy Table of Content