Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Java 9: Factory Methods to Create Immutable Collections

DZone's Guide to

Java 9: Factory Methods to Create Immutable Collections

Creating immutable collections will be way more convenient in Java 9, thanks to the newly added factory methods in collection interfaces.

Free Resource

Bitbucket is for the code that takes us to Mars, decodes the human genome, or drives your next car. What will your code do? Get started with Bitbucket today, it's free.

In this article, we will see another JDK 9 feature — creating immutable collections. Until Java 8, if we wanted to create immutable collections, we used to call unmodifiableXXX() methods on java.util.Collections. For example,  To create an unmodifiable list, we should write:

jshell> List<String> list = new ArrayList<String>();
list ==> []

jshell> list.add("Smart")
$2 ==> true

jshell> list.add("Techie")
$3 ==> true

jshell> System.out.println("The values are: "+ list);
The list values are: [Smart, Techie]

jshell> // make the list unmodifiable

jshell>    List<String> immutablelist = Collections.unmodifiableList(list);
immutablelist ==> [Smart, Techie]

jshell> // try to modify the list

jshell>    immutablelist.add("Smart_1")
|  java.lang.UnsupportedOperationException thrown:
|        at Collections$UnmodifiableCollection.add (Collections.java:1056)
|        at (#6:1)

jshell>


The above code is too verbose to create a simple unmodifiable List. As Java is adopting functional programming style, Java 9 came up with convenient, more compacted factory methods to create unmodifiable collections, as seen in JEP 269. Let us see how that works.

Create Empty List

jshell> List immutableList = List.of();
immutableList ==> []

//Add an item to the list
jshell> immutableList.add("Smart")
|  Warning:
|  unchecked call to add(E) as a member of the raw type java.util.List
|  immutableList.add("Smart")
|  ^------------------------^
|  java.lang.UnsupportedOperationException thrown:
|        at ImmutableCollections.uoe (ImmutableCollections.java:70)
|        at ImmutableCollections$AbstractImmutableList.add (ImmutableCollections.java:76)
|        at (#2:1)


Create Non-Empty List

jshell> List immutableList = List.of("Smart","Techie");
immutableList ==> [Smart, Techie]

jshell> //add an item to the list

jshell> immutableList.add("Smart_1")
|  Warning:
|  unchecked call to add(E) as a member of the raw type java.util.List
|  immutableList.add("Smart_1")
|  ^--------------------------^
|  java.lang.UnsupportedOperationException thrown:
|        at ImmutableCollections.uoe (ImmutableCollections.java:70)
|        at ImmutableCollections$AbstractImmutableList.add (ImmutableCollections.java:76)
|        at (#2:1)

jshell>


Create Non-Empty Map

jshell> Map immutableMap = Map.of(1,"Smart",2,"Techie");
immutableMap ==> {1=Smart, 2=Techie}

//Get item from Map
jshell> immutableMap.get(1);
$2 ==> "Smart"

//Add item to map
jshell> immutableMap.put(3,"Smart_1");
|  Warning:
|  unchecked call to put(K,V) as a member of the raw type java.util.Map
|  immutableMap.put(3,"Smart_1
|  ^---------------------------^
|  java.lang.UnsupportedOperationException thrown:
|        at ImmutableCollections.uoe (ImmutableCollections.java:70)
|        at ImmutableCollections$AbstractImmutableMap.put (ImmutableCollections.java:557)
|        at (#3:1)

jshell>


If you look at the above Java 9 factory method, the code is a simple one liner to create immutable collections. In an upcoming article, we will see another Java 9 feature. Stay tuned!

Bitbucket is the Git solution for professional teams who code with a purpose, not just as a hobby. Get started today, it's free.

Topics:
java 9 ,immutable collections ,factory methods ,tutorial ,java

Published at DZone with permission of Siva Prasad Rao Janapati, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

The best of DZone straight to your inbox.

SEE AN EXAMPLE
Please provide a valid email address.

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.
Subscribe

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}