Optional is in air due to coronavirus, everything is becoming optional like optional public gathering , optional work from home, optional travel etc.

I though it is good time to talk about real “Optional” in software engineering that deals with NULL reference.

Tony Hoare confessed that he made billion dollar mistake by inventing Null. If you have not seen his talk then i will suggest to have look at Null-References-The-Billion-Dollar-Mistake.

I will share some of the anti pattern with null and how it can be solved using abstraction like Optional or MayBe.

For this example we will use simple value object that can have some null values.

public class Person {
 final String firstName;
 final String lastName;
 
 final String email; // This can be null
 final String phone; //This can be null
}

This value object can have null value for email & phone number.

Scenario: Contact Person on both email and phone number

Not using optional

First attempt will be based on checking null like below

//Not using optional
 if (p.email != null) {
 System.out.println("Sending email to " + p.email);
 }

 if (p.phone != null) {
 System.out.println("Calling " + p.phone);
 }

This is how it has been done for years. One more common pattern with collection result.

List<Person> p = searchPersonById("100");

 if (p.isEmpty()) {
 System.out.println("No result");
 } else {
 System.out.println("Person" + p.get(0));
 }

Use optional in wrong way

Optional<String> phone = contactNumber(p);
 Optional<String> email = email(p);

 if (phone.isPresent()) {
 System.out.println("Calling Phone " + phone.get());
 }
 if (email.isPresent()) {
 System.out.println("Sending Email " + email.get());
 }

This is little better but all the goodness of Optional is thrown away by adding if/else block in code.

Always Happy optional

//Always Happy
 Optional<String> phone = contactNumber(p);
 Optional<String> email = email(p);

 System.out.println("Calling Phone " + phone.get());
 System.out.println("Sending Email " + email.get());

It is good be happy but when you try that with Optional you are making big assumption or you don’t need optional.

Nested property optional

For this scenario we will extend Person object and add Home property. Not everyone can own home so it is good candidate that it will be not available .

Lets see how contacting person scenario work in this case

//Nested Property
 if (p.getHome() != null) {
 System.out.println("Sending Postal mail " + p.getHome().address);
 }


 if (p.getHome() != null && p.getHome().getInsurance() != null) {
 System.out.println("Sending Notification to insurance " + p.getHome().getInsurance().getAgency());
 }

This is where it start to become worse that code will have tons of nested null checks.

Priority based default

for this scenario we first try to contact person on home address and if it is not available then contact on office address.

//Address has priority , first home and then Office

 if (p.home != null) {
 System.out.println("Contacted at home address " + p.home.address);
 return; // Magical return for early exit
 }

 if (p.office != null) {
 System.out.println("Contacted at office address " + p.office.address);
 return; // Magical return for early exit
 }

Such type of scenario require use of advance control flow for early return and makes code hard to understand and maintain.

These are some of the common pattern where optional are not used or used in wrong way.

Optional usage patterns

Lets look at some of good ways of using optional.

Make property optional based on domain knowledge

It is very easy to makes property optional.

public Optional<String> getEmail() {
 return Optional.ofNullable(email);
 }

 public Optional<String> getPhone() {
 return Optional.ofNullable(phone);
 }

Yes it is allowed to make get Optional, no one will hang you for that and feel free to do that without fear. Once that change is done we can write something like below

//Use Optional
 p.getEmail().ifPresent(email -> System.out.println("Sending email to " + email));
 p.getPhone().ifPresent(phone -> System.out.println("Calling " + phone));

//Optional for Collection or Search type of request
 Optional