{"id":51,"date":"2023-02-03T10:11:23","date_gmt":"2023-02-03T10:11:23","guid":{"rendered":"https:\/\/java-online-training.de\/?p=51"},"modified":"2023-04-17T08:23:51","modified_gmt":"2023-04-17T08:23:51","slug":"java-19-pattern-matching-for-switch-expressions","status":"publish","type":"post","link":"https:\/\/java-online-training.de\/?p=51","title":{"rendered":"Java 19: Pattern Matching for switch Expressions"},"content":{"rendered":"\n

One of the great additions to the Java core language features was pattern matching<\/strong> introduced with Java 17<\/strong>. Pattern matching is a fancy term for a very useful new mechanic that reduces the need to cast objects and explicitly declare variables when using switch statements<\/strong> or the instanceof operator<\/strong>. <\/p>\n\n\n\n

As a quick refresher let’s look at a simple example for pattern matching that is valid since Java 17. <\/p>\n\n\n\n

As a starting point, we have a simple class hierarchy of two different birds:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
sealed<\/span> <\/span>interface<\/span> <\/span>Bird<\/span> <\/span>permits<\/span> <\/span>Thunderbird<\/span>, <\/span>Hummingbird<\/span> {<\/span><\/span>\n\tString <\/span>twitter<\/span>();<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nfinal<\/span> <\/span>class<\/span> <\/span>Hummingbird<\/span> <\/span>implements<\/span> <\/span>Bird<\/span> {<\/span><\/span>\n\t<\/span>public<\/span> String <\/span>twitter<\/span>() {<\/span><\/span>\n\t\t<\/span>return<\/span> <\/span>"hummmmm"<\/span>;<\/span><\/span>\n\t}<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nfinal<\/span> <\/span>class<\/span> <\/span>Thunderbird<\/span> <\/span>implements<\/span> <\/span>Bird<\/span> {<\/span><\/span>\n\t<\/span>public<\/span> String <\/span>twitter<\/span>() {<\/span><\/span>\n\t\t<\/span>return<\/span> <\/span>""<\/span>;<\/span><\/span>\n\t}<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
In line (1) I  declare a sealed interface Bird<\/em> with two possible implementations: the Hummingbird <\/em>and the Thunderbird<\/em>. Both of them implement the method twitter <\/em>from the parent interface Bird<\/em>. <\/p>\n\n\n\n
Next, let’s write some code that uses pattern matching<\/strong> to differentiate between those two:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
public<\/span> <\/span>static<\/span> <\/span>void<\/span> <\/span>twitter<\/span>(Bird bird) {<\/span><\/span>\n<\/span>\n  <\/span>if<\/span> (bird <\/span>instanceof<\/span> Hummingbird humm ) {<\/span><\/span>\n\tSystem.out.<\/span>println<\/span>(<\/span>"Hummingburd twitters: "<\/span>+<\/span>humm.<\/span>twitter<\/span>() );<\/span><\/span>\n  } <\/span>else<\/span> <\/span>if<\/span> (bird <\/span>instanceof<\/span> Thunderbird thunder) {<\/span><\/span>\n\tSystem.out.<\/span>println<\/span>(<\/span>"Thunderbird twitters: "<\/span>+<\/span>thunder.<\/span>twitter<\/span>());<\/span><\/span>\n  }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
In line (3) and (5) you can see pattern matching in action. By checking the type of the bird variable by the instanceof <\/strong>operator, I declare a variable of the same type at the same time.  Just to see the difference, here is the pre Java 17 version<\/strong> of this code:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
public<\/span> <\/span>static<\/span> <\/span>void<\/span> <\/span>twitterOld<\/span>(Bird bird) {<\/span><\/span>\n  <\/span>if<\/span> (bird <\/span>instanceof<\/span> Hummingbird) {<\/span><\/span>\n    Hummingbird<\/span> <\/span>humm<\/span> <\/span>=<\/span> (Hummingbird)bird;<\/span><\/span>\n    System.out.<\/span>println<\/span>(<\/span>"Hummingburd twitters: "<\/span>+<\/span>humm.<\/span>twitter<\/span>());<\/span><\/span>\n  } <\/span>else<\/span> <\/span>if<\/span> (bird <\/span>instanceof<\/span> Thunderbird ) {<\/span><\/span>\n    Thunderbird<\/span> <\/span>thunder<\/span> <\/span>=<\/span> (Thunderbird)bird;<\/span><\/span>\n    System.out.<\/span>println<\/span>(<\/span>"Thunderbird twitters: "<\/span>+<\/span>thunder.<\/span>twitter<\/span>());<\/span><\/span>\n  }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
In line (3) and (6) we can see the variable definition and casting that we needed although it was already clear in line 2 and 5 what type of object we were dealing with. <\/p>\n\n\n\n
You might think, that this would be better done in a switch statement<\/strong> and luckily, with Java 19 released, there is another preview feature that let us do exactly that. The enhancements are in detail explained in JEP 427,<\/a> so check that JEP out if you want to know all the nasty details.<\/p>\n\n\n\n
Let’s rewrite the above code to use the new switch statement:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
public<\/span> <\/span>static<\/span> <\/span>void<\/span> <\/span>switchTwitter<\/span>(Bird bird) {<\/span><\/span>\n  <\/span>switch<\/span>( bird ) {<\/span><\/span>\n    <\/span>case<\/span> Hummingbird humm <\/span>-><\/span> <\/span><\/span>\n      System.out.<\/span>println<\/span>(<\/span>"Hummingbird twitters:"<\/span>+<\/span>humm.<\/span>twitter<\/span>());<\/span><\/span>\n    <\/span>case<\/span> Thunderbird thunder <\/span>-><\/span> \t<\/span><\/span>\n      System.out.<\/span>println<\/span>(<\/span>"Thunderbird twitters:"<\/span>+<\/span>thunder.<\/span>twitter<\/span>());<\/span><\/span>\n  }  <\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
This looks a lot cleaner than the previous example using instanceof<\/strong>. You can simple test on the type of an object in the case <\/em>statement and declare a local variable at the same time. The conditional code which should be executed follows the case <\/strong>in something that looks a lot like a lambda expression.  This new mechanic is also sometimes referred to as a type switch<\/strong>.<\/p>\n\n\n\n
But that’s not all you can do with the enhanced switch statement. Let’s expand our object model a little and introduce a method age()<\/em> on the interface level, which returns the age of the bird:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
sealed<\/span> <\/span>interface<\/span> <\/span>Bird<\/span> <\/span>permits<\/span> <\/span>Thunderbird<\/span>, <\/span>Hummingbird<\/span> {<\/span><\/span>\n  String <\/span>twitter<\/span>();<\/span><\/span>\n  <\/span>int<\/span> <\/span>age<\/span>();\t<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nfinal<\/span> <\/span>class<\/span> <\/span>Hummingbird<\/span> <\/span>implements<\/span> <\/span>Bird<\/span> {<\/span><\/span>\n<\/span>\n  <\/span>private<\/span> <\/span>int<\/span> <\/span>age;<\/span><\/span>\n\t<\/span><\/span>\n  <\/span>public<\/span> <\/span>Hummingbird<\/span>(<\/span>int<\/span> <\/span>age<\/span>) {<\/span><\/span>\n    <\/span>this<\/span>.age <\/span>=<\/span> age; <\/span><\/span>\n  }<\/span><\/span>\n\t<\/span><\/span>\n  <\/span>public<\/span> <\/span>int<\/span> <\/span>age<\/span>() { <\/span>return<\/span> age; }<\/span><\/span>\n\t<\/span><\/span>\n  <\/span>public<\/span> String <\/span>twitter<\/span>() { <\/span>return<\/span> <\/span>"hummmmm"<\/span>; }<\/span><\/span>\n}<\/span><\/span>\n<\/span>\nfinal<\/span> <\/span>class<\/span> <\/span>Thunderbird<\/span> <\/span>implements<\/span> <\/span>Bird<\/span> {<\/span><\/span>\n\t<\/span><\/span>\n  <\/span>private<\/span> <\/span>int<\/span> <\/span>age;<\/span><\/span>\n\t<\/span><\/span>\n  <\/span>public<\/span> <\/span>Thunderbird<\/span>(<\/span>int<\/span> <\/span>age<\/span>) {<\/span><\/span>\n    <\/span>this<\/span>.age <\/span>=<\/span> age; <\/span><\/span>\n  }<\/span><\/span>\n<\/span>\n  <\/span>public<\/span> <\/span>int<\/span> <\/span>age<\/span>() { <\/span>return<\/span> age; }<\/span><\/span>\n<\/span>\n  <\/span>public<\/span> String <\/span>twitter<\/span>() { <\/span>return<\/span> <\/span>""<\/span>; }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
In this preview of the switch pattern matching feature you can check for the type of the object and also check for a boolean expression using the object at the same time<\/strong>. This is very handy if your logic depends not only on the type but different properties of your object. <\/p>\n\n\n\n
Here is an example that checks for the age of the birds inside the switch statement :<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
public<\/span> <\/span>static<\/span> <\/span>void<\/span> <\/span>switchTwitterForYoungBirds<\/span>(Bird bird) {<\/span><\/span>\n  <\/span>switch<\/span>( bird ) {<\/span><\/span>\n    <\/span>case<\/span> Hummingbird humm when humm.<\/span>age<\/span>() <\/span><<\/span> <\/span>3<\/span> <\/span>-><\/span> <\/span><\/span>\n      System.out.<\/span>println<\/span>(<\/span>"Hummingbird twitters: "<\/span>+<\/span> humm.<\/span>twitter<\/span>() );<\/span><\/span>\n    <\/span>case<\/span> Thunderbird thunder when thunder.<\/span>age<\/span>() <\/span><<\/span> <\/span>5<\/span> <\/span>-><\/span> \t<\/span><\/span>\n      System.out.<\/span>println<\/span>(<\/span>"Thunderbird twitters: "<\/span>+<\/span>thunder.<\/span>twitter<\/span>());<\/span><\/span>\n    <\/span>default<\/span> <\/span>-><\/span> System.out.<\/span>println<\/span>(<\/span>"Bird is too old to twitter."<\/span>);<\/span><\/span>\n  }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
In line (3) and (5) we can see a so called guarded pattern<\/strong> in action. First the variable humm <\/strong>is declared if the provided Bird <\/em>object is of type Hummingbird<\/em>. After this, the keyword when <\/strong>is used to start a boolean expression. This expression can also consist of more nested boolean logic as long as it evaluates to a single boolean. If the expression is true, the code after the arrow is executed. Finally, I covered all cases with older birds by a default case, that again prints some text to the console.  This reduces the required code a lot compared to nested if statements inside your case blocks. <\/p>\n\n\n\n
One more thing to mention is, that a type switch statement must always cover all possible types of the type hierarchy.  If you have no default clause, the compiler will throw a compile error indicating that not all cases are covered. That’s pretty neat if somebody extends a class hierarchy and forgets about updating all the type switches the hierarchy is used in.  <\/p>\n\n\n\n
To complete this overview, the new type switch also accepts one null value statement. Here is a small example for our bird type switch with a null case:<\/p>\n\n\n\n
<\/p>\n\n\n\n
It is really great that Oracle spends a good chunk of work on introducing new Java language features and tries to remove lengthy boilerplate code, that Java is so famous of.  With the improved pattern matching, Java code is much more modern, easy to read and to understand.  <\/p>\n\n\n\n
If you want to check out these examples yourself, you can find the code in this github repository.<\/a> <\/p>\n\n\n\n
The improved switch statement was released as a preview feature in Java 19. To compile and run your code with previews enabled, check out this page<\/a>. <\/p>\n","protected":false},"excerpt":{"rendered":"
One of the great additions to the Java core language features was pattern matching introduced with Java 17. Pattern matching is a fancy term for a very useful new mechanic that reduces the need to cast objects and explicitly declare variables when using switch statements or the instanceof operator. As a quick refresher let’s look […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[9],"tags":[4,8,7,10],"class_list":["post-51","post","type-post","status-publish","format-standard","hentry","category-java-19","tag-java-19","tag-pattern-matching","tag-preview","tag-project-amber"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/java-online-training.de\/index.php?rest_route=\/wp\/v2\/posts\/51","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/java-online-training.de\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/java-online-training.de\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/java-online-training.de\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/java-online-training.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=51"}],"version-history":[{"count":20,"href":"https:\/\/java-online-training.de\/index.php?rest_route=\/wp\/v2\/posts\/51\/revisions"}],"predecessor-version":[{"id":369,"href":"https:\/\/java-online-training.de\/index.php?rest_route=\/wp\/v2\/posts\/51\/revisions\/369"}],"wp:attachment":[{"href":"https:\/\/java-online-training.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=51"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/java-online-training.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=51"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/java-online-training.de\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=51"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}