Pattern Matching: Small Enhancement or Major Feature?

#JFall #PatternMatching @hannotify @PeterWessels
Pattern
Pattern
Pattern
Pattern
Pattern
Pattern
Pattern
Pattern
Pattern
Pattern
Pattern
Pattern
Matching
Matching
Matching
Matching
Matching
Matching
Matching
Matching
Matching
Matching
Matching
Matching
Small Enhancement or Major
Small Enhancement or Major
Feature?
Feature?
Hanno Embregts @hannotify

Small Enhancement
Small Enhancement
Small Enhancement
Small Enhancement
Small Enhancement
https://gph.is/g/ZPJNoPQ

Major Feature
Major Feature
Major Feature
Major Feature
Major Feature
https://thumbs.gfycat.com/DefiantElasticGadwall.webp

Pattern
Pattern
Pattern
Pattern
Pattern
Matching for
Matching for
Matching for
Matching for
Matching for
instanceof
instanceof
instanceof
instanceof
instanceof
https://pxhere.com/en/photo/752901

Instanceof-and-cast
Instanceof-and-cast
if (product instanceof Guitar) {
Guitar lesPaul =
(Guitar) product;
// use lesPaul
}
1
2
3
4
5

Instanceof-and-cast
Instanceof-and-cast
if (product instanceof Guitar) { // 1. is product a Guitar?
1
Guitar lesPaul =
2
(Guitar) product;
3
// use lesPaul
4
}
5

Instanceof-and-cast
Instanceof-and-cast
(Guitar) product; // 2. perform conversion
1
Guitar lesPaul =
2
3
// use lesPaul
4
}
5

Instanceof-and-cast
Instanceof-and-cast
Guitar lesPaul = // 3. declare variable, bind value
1
2
3
// use lesPaul
4
}
5

Improve the situation
Guitar lesPaul = // 3. declare variable, bind value
// use lesPaul
}
1
2
3
4
5

if (product instanceof Guitar lesPaul) {
1
2 // use lesPaul
3 }

Type pattern
Type pattern
Type pattern
Type pattern
Type pattern
Consists of a predicate that specifies a
type, along with a single binding variable.
https://www.pexels.com/photo/person-holding-white-chalk-625219/

Pattern matching
Pattern matching
Pattern matching
Pattern matching
Pattern matching
Allows the conditional extraction of
components from objects to be
expressed more concisely and safely.
https://www.pexels.com/photo/person-holding-white-chalk-625219/

Demo
Demo
Simplify implementation of equals

Declaring 'in the middle'
Declaring 'in the middle'
if (product instanceof Guitar lesPaul) {
// use lesPaul
}
1
2
3

Scoping
Scoping
Pattern binding variable ('flow scoping')
Pattern binding variable ('flow scoping')
The set of places where it would definitely be assigned.
if (product instanceof Guitar lesPaul && lesPaul.isInTune()) {
// can use lesPaul here
} else {
// can't use lesPaul here
}
1
2
3
4
5

It's a kind of Pattern
pattern example
type pattern Guitar lesPaul

Feature Status
Feature Status
Type Patterns
Type Patterns
Java version Feature status JEP
14 Preview
15 Second preview
16 Final
JEP 305
JEP 375
JEP 394

Pattern
Pattern
Pattern
Pattern
Pattern
Matching for
Matching for
Matching for
Matching for
Matching for
switch
switch
switch
switch
switch https://pxhere.com/en/photo/752901

String apply(Effect effect) {
String formatted = "";
if (effect instanceof Delay) {
Delay de = (Delay) effect;
formatted = String.format("Delay active of %d ms.", de.getTimeInMs()
} else if (effect instanceof Reverb) {
Reverb re = (Reverb) effect;
formatted = String.format("Reverb active of type %s and roomSize %d.
} else if (effect instanceof Overdrive) {
Overdrive ov = (Overdrive) effect;
formatted = String.format("Overdrive active with gain %d.", ov.getGa
} else if (effect instanceof Tremolo) {
Tremolo tr = (Tremolo) effect;
formatted = String.format("Tremolo active with depth %d and rate %d.
} else if (effect instanceof Tuner) {
Tuner tu (Tuner) effect;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

formatted String.format( Reverb active of type %s and roomSize %d.
formatted = String.format("Tuner active with pitch %d. Muting all si
formatted = el.getEffects().stream().map(this::apply).collect(Collec
formatted = String.format("Unknown effect active: %s.", effect);
8
} else if (effect instanceof Overdrive) {
9
Overdrive ov = (Overdrive) effect;
10
11
} else if (effect instanceof Tremolo) {
12
Tremolo tr = (Tremolo) effect;
13
14
} else if (effect instanceof Tuner) {
15
Tuner tu = (Tuner) effect;
16
17
} else if (effect instanceof EffectLoop) {
18
EffectLoop el = (EffectLoop) effect;
19
20
} else {
21
22
}
23

String formatted = "";
if (effect instanceof Delay de) {
} else if (effect instanceof Reverb re) {
} else if (effect instanceof Overdrive ov) {
} else if (effect instanceof Tremolo tr) {
} else if (effect instanceof Tuner tu) {
} else if (effect instanceof EffectLoop el) {
1
2
3
4 formatted = String.format("Delay active of %d ms.", de.getTimeInMs()
5
6 formatted = String.format("Reverb active of type %s and roomSize %d.
7
8 formatted = String.format("Overdrive active with gain %d.", ov.getGa
9
10 formatted = String.format("Tremolo active with depth %d and rate %d.
11
12 formatted = String.format("Tuner active with pitch %d. Muting all si
13
14 formatted = el.getEffects().stream().map(this::apply).collect(Collec
15 } else {
16 formatted String format("Unknown effect active: %s " effect);

formatted = String.format( Delay active of %d ms. , de.getTimeInMs()
formatted = String.format("Reverb active of type %s and roomSize %d.
formatted = String.format("Tuner active with pitch %d. Muting all si
formatted = el.getEffects().stream().map(this::apply).collect(Collec
formatted = String.format("Unknown effect active: %s.", effect);
4
} else if (effect instanceof Reverb re) {
5
6
} else if (effect instanceof Overdrive ov) {
7
8
} else if (effect instanceof Tremolo tr) {
9
10
} else if (effect instanceof Tuner tu) {
11
12
} else if (effect instanceof EffectLoop el) {
13
14
} else {
15
16
}
17
return formatted;
18
}
19

Switch expression
Switch expression
1 String apply(Effect effect) {
2 return switch(effect) {
3 default -> String.format("Unknown effect active: %s.", eff
4 };
5 }

Switch expression
Switch expression
case Delay de -> String.format("Delay active of %d ms.", de.getT
case Reverb re -> String.format("Reverb active of type %s and roo
1
return switch(effect) {
2
3
4
5 default -> String.format("Unknown effect active: %s.", eff
6 };
7 }

Switch expression
Switch expression
1 String apply(Effect effect) {
3 case Delay de -> String.format("Delay active of %d ms.", de.get
4 case Reverb re -> String.format("Reverb active of type %s and ro
5 case Overdrive ov -> String.format("Overdrive active with gain %d."
6 case Tremolo tr -> String.format("Tremolo active with depth %d an
7 case Tuner tu -> String.format("Tuner active with pitch %d. Mut
8 default -> String.format("Unknown effect active: %s.", ef
9 };
10 }

Switch expression
Switch expression
case EffectLoop el -> el.getEffects().stream().map(this::apply).coll
1
2
case Delay de -> String.format("Delay active of %d ms.", de.get
3
case Reverb re -> String.format("Reverb active of type %s and ro
4
case Overdrive ov -> String.format("Overdrive active with gain %d."
5
case Tremolo tr -> String.format("Tremolo active with depth %d an
6
case Tuner tu -> String.format("Tuner active with pitch %d. Mut
7
8
9 default -> String.format("Unknown effect active: %s.", ef
10 };
11 }

Switch expression
Switch expression
default -> String.format("Unknown effect active: %s.", ef
};
}
1
2
3
4
5
6
7
8
9
10
11

Sensible operations to the effect
Sensible operations to the effect
loop
loop
apply()
setVolume(int volume)
contains(Effect... effect)

Nonsensical operations to the
Nonsensical operations to the
effect loop
effect loop
isTunerActive()
isDelayTimeEqualToReverbRoomSize()
isToneSuitableToPlayPrideInTheNameOfLove()

Switch expression
Switch expression
static String apply(Effect effect) {
case EffectLoop el -> el.getEffects().stream().map(Effect::apply).co
};
}
1
2
3
4
5
6
7
8
9
10
11

Benefits of pattern
Benefits of pattern
matching
matching
No need for the Visitor pattern or a common supertype
A single expression instead of many assignments
Less error-prone (in adding cases)
More concise
Safer - the compiler can check for missing cases

But what if
But what if effect
effect is
is null
null?
?
return switch(effect) { // throws NullPointerException!
1
2
3
4
5
6
7
8
9
};
10
}
11

Combining case labels
Combining case labels
case null, default -> String.format("Unknown or malfunctioning effec
1
2
3
4
5
6
7
8
9
};
10
}
11

Demo
Demo
Guarded patterns

Guarded patterns
Guarded patterns
String apply(Effect effect, Guitar guitar) {
// (...)
case Tremolo tr -> String.format("Tremolo active with depth %d and ra
case Tuner tu -> String.format("Tuner active with pitch %d. Muting al
case EffectLoop el -> el.getEffects().stream().map(this::apply).colle
default -> String.format("Unknown effect active: %s.", effect);
};
}
1
2
3
4
5
6
7
8
9

Guarded patterns
Guarded patterns
case Tuner tu && !tu.isInTune(guitar) -> String.format("Guitar is in
1
2
// (...)
3
4
5
6
7
};
8
}
9

Guarded patterns
Guarded patterns
case Tuner tu when !tu.isInTune(guitar) -> String.format("Guitar is i
1
2
// (...)
3
4
5
6
7
};
8
}
9

Guarded patterns
Guarded patterns
switch(effect) {
// ...
case Tuner tu:
if (!tu.isInTune(guitar)) { // tuning is needed }
else { // no tuning is needed }
break;
// ...
}
1
2
3
4
5
6
7
8

pattern example
guarded pattern Tuner tu when
!tu.isInTune(guitar)

Feature Status
Feature Status
Pattern Matching for Switch
Pattern Matching for Switch
17 Preview
18 Second preview
19 Third preview
20 Fourth preview
JEP 406
JEP 420
JEP 427
JEP 433

Deconstructio
Deconstructio
Deconstructio
Deconstructio
Deconstructio
n Patterns
n Patterns
n Patterns
n Patterns
n Patterns

Disclaimer
Disclaimer
Disclaimer
Disclaimer
Disclaimer
We can't tell you when the following
features are coming to Java. Also: syntax
and implementation specifics may still
change.

Deconstruction patterns
};
}
1
2
3
4
5
6
7
8
9
10
11

case Overdrive(int gain) -> String.format("Overdrive active with gai
1
2
3
4
5
6
7
8
9
};
10
}
11

Pattern definition
Pattern definition
public class Overdrive implements Effect {
private final int gain;
public Overdrive(int gain) {
this.gain = gain;
}
}
1
2
3
4
5
6
7

Pattern definition
Pattern definition
1 public class Overdrive implements Effect {
2 private final int gain;
3
4 public Overdrive(int gain) {
5 this.gain = gain;
6 }
7
public pattern Overdrive(int gain) {
8
gain = this.gain;
9
}
10
11 }

Demo
Demo
Deconstruction with Records

case Delay(int timeInMs) -> String.format("Delay active of %d ms.",
case Reverb(String name, int roomSize) -> String.format("Reverb acti
case Tremolo(int depth, int rate) -> String.format("Tremolo active w
case Tuner(int pitchInHz) -> String.format("Tuner active with pitch
case EffectLoop(Set<Effect> effects) -> effects.stream().map(this::a
};
}
1
2
3
4
5
6
7
8
9
10
11

Can we combine patterns?
Can we combine patterns?
static boolean isDelayTimeEqualToReverbRoomSize(EffectLoop effectLoop) {
}
1
2
3

Pattern composition
Pattern composition
if (effectLoop instanceof EffectLoop(Delay(int timeInMs), Reverb(String n
return timeInMs == roomSize;
1
2
3
}
4
return false;
5
6 }

Pattern composition
Pattern composition
1 static boolean isDelayTimeEqualToReverbRoomSize(EffectLoop effectLoop) {
2 return effectLoop.getEffects().stream()
3 .filter(e -> e instanceof Delay || e instanceof Reverb)
4 .map(dr -> {
5 if (dr instanceof Delay d) {
6 return d.getTimeInMs();
} else {
7
Reverb r = (Reverb) dr;
8
return r.getRoomSize();
9
}
10
11
}).distinct().count() == 1;
12
13 }

Var patterns
Var patterns
// Pre-Java 10
Guitar telecaster = new Guitar("Fender Telecaster Baritone Blacktop", GuitarT
// Java 10
var telecaster = new Guitar("Fender Telecaster Baritone Blacktop", GuitarType
1
2
3
4
5
https://openjdk.java.net/jeps/286
https://openjdk.java.net/jeps/286

Var patterns
Var patterns
if (effectLoop instanceof EffectLoop(Delay(int timeInMs), Reverb(String n
}
return false;
}
1
2
3
4
5
6

Var patterns
Var patterns
if (effectLoop instanceof EffectLoop(Delay(var timeInMs), Reverb(var name
1
2
3
}
4
return false;
5
}
6

Benefits of
Benefits of
deconstruction patterns
deconstruction patterns
Better encapsulation
a case branch only receives data that it actually references.
More elegant logic
by using pattern composition

pattern example
deconstruction pattern Delay(int timeInMs)

pattern example
var pattern var timeInMs

Feature Status
Feature Status
Java
version
Feature status JEP
19 Preview (deconstruction with record
patterns only)
n/a Second preview (deconstruction with
record patterns only)
JEP
405
JEP
432

Pattern Matching Plays
Pattern Matching Plays
Nice With
Nice With
Sealed Types
Sealed Types
Sealed Types
Sealed Types
Sealed Types
and Records
and Records
and Records
and Records
and Records

Demo
Demo
Make Effect a sealed type

Sealed types yield completeness
case EffectLoop(Tuner(int pitchInHz), _) -> String.format("The Effec
case EffectLoop(var effects) -> effects.stream().map(Effect::apply).
};
}
1
2
3
4
5
6
7
8
9
10
11
12

case EffectLoop(Tuner(int pitchInHz), _) -> String.format("The Effec
1
2
3
4
5
6
7
8
9
10 };
11 }
https://openjdk.org/projects/amber/design-notes/patterns/pattern-matching-for-java

Records
Records
Input:
Input:
Commit to the class being a transparent carrier for its
data.
Output:
Output:

Patterns in enhanced for
record Delay(int timeInMs) implements Effect {}
1
static void printDelays(List<Delay> delays) {
for (Delay delay : delays) {
System.out.println("Delay found with timeInMs=" + delay.timeInMs());
}
}
1
2
3
4
5

record Delay(int timeInMs) implements Effect {}
1
static void printDelays(List<Delay> delays) {
for (Delay(int timeInMs) : delays) {
System.out.println("Delay found with timeInMs=" + timeInMs);
}
}
1
2
3
4
5

Feature Status
Feature Status
Sealed Types
Sealed Types
15 Preview
16 Second preview
17 Final
JEP 360
JEP 397
JEP 409

Feature Status
Feature Status
Completeness
Completeness
17 Preview
18 Second preview
19 Third preview
JEP 406
JEP 420
JEP 427

Feature Status
Feature Status
Record Patterns
Record Patterns
19 Preview
n/a Second preview
JEP 405
JEP 432

A Better
A Better
A Better
A Better
A Better
Serialization?
Serialization?
Serialization?
Serialization?
Serialization?

Here be dragons!
Here be dragons!
Here be dragons!
Here be dragons!
Here be dragons!
We can't be sure at all that the following
features will appear in Java as depicted.
They can change a lot in the meantime.
https://www.pexels.com/photo/dragon-festival-during-nighttime-6068535/

Opposites
Opposites
Deconstruction pattern
Deconstruction pattern
transforms an object into a set of typed fields
Constructor
Constructor
transforms a set of typed fields into an object

Serialization
Serialization
very important feature
but many people hate its current implementation
Drawbacks
Drawbacks
it undermines the accessibility model
serialization logic is not 'readable code'
it bypasses constructors and data validation

Serialization
Serialization
public class EffectLoop implements Effect {
private String name;
private Set<Effect> effects;
public EffectLoop(String name) {
this.name = name;
this.effects = new HashSet<>();
}
}
1
2
3
4
5
6
7
8
9

Serialization
Serialization
1 public class EffectLoop implements Effect {
2 private String name;
3 private Set<Effect> effects;
4
5 public EffectLoop(String name) {
6 this.name = name;
7 this.effects = new HashSet<>();
8 }
9
public pattern EffectLoop(String name, Effect[] effects) {
10
name = this.name;
11
effects = this.effects.toArray();
12
}
13
14 }

Serialization
Serialization
public EffectLoop(String name, Effect[] effects) {
this(name);
for (Effect effect : effects) {
this.effects.add(effect);
}
7
}
8
9
10
11
12
13
14
15 }
16
17 public pattern EffectLoop(String name, Effect[] effects) {
18 name = this.name;
19 effects = this.effects.toArray();
}
20
21 }

Serialization
Serialization
public class EffectLoop implements Effect {
private String name;
private Set<Effect> effects;
public EffectLoop(String name) {
this.name = name;
}
@Deserializer
1
2
3
4
5
6
7
8
9
10
11 public EffectLoop(String name, Effect[] effects) {
12 this(name);
13 for (Effect effect : effects) {
14 this.effects.add(effect);
15 }
16 }

Some challenges remain
Some challenges remain
Q:
Q: How to support multiple versions of one class?
How to support multiple versions of one class?
A: @Serializer and @Deserializer annotations could
get a property version in the future.

Feature Status
Feature Status
Java
version
Feature status JEP
n/a Exploratory
document
Towards Better
Serialization
https://cr.openjdk.java.net/~briangoetz/amber/serialization.html

Future
Future
Future
Future
Future
Expansions
Expansions
Expansions
Expansions
Expansions

Unnamed patterns
Unnamed patterns
if (effectLoop instanceof EffectLoop(Delay(var timeInMs), Reverb(var name
1
2
3
}
4
return false;
5
}
6

Unnamed patterns
Unnamed patterns
if (effectLoop instanceof EffectLoop(Delay(var timeInMs), Reverb(_, var r
}
return false;
}
1
2
3
4
5
6

Optimization
Optimization
};
}
1
2
3
4
5
6
7
8
9
10
11

Optimization
Optimization
1 static String apply(Effect effect) {
3 // ...
4 case EffectLoop(var effects) -> effects.stream().map(Effect::apply).c
5 default -> String.format("Unknown effect active: %s.", effect);
6 };
7 }

Optimization
Optimization
case EffectLoop(Tuner(int pitchInHz), _) -> String.format("The Effect
1
2
// ...
3
4
5 case EffectLoop(var effects) -> effects.stream().map(Effect::apply).c
6 default -> String.format("Unknown effect active: %s.", effect);
7 };
8 }

pattern example
unnamed pattern _
var pattern var timeInMs

Feature Status
Feature Status
Unnamed Patterns
Unnamed Patterns
n/a JEP draft 8294349
https://openjdk.org/jeps/8294349
https://openjdk.org/jeps/8294349

Pattern bind statements
var reverb = new Reverb("ChamberReverb", 2);
__let Reverb(String name, int roomSize) = reverb;
// do something with name & roomSize
1
2
3
4
5
https://openjdk.org/projects/amber/design-notes/patterns/pattern-matching-for-java

else throw new IllegalArgumentException("not a Reverb!");
var reverb = new Reverb("ChamberReverb", 2);
1
2
__let Reverb(String name, int roomSize) = reverb;
3
4
5
6 // do something with name & roomSize

Array patterns
Array patterns
record EffectLoop(String name, int volume, Effect... effects) { }
1
static String apply(EffectLoop effectLoop) {}
return switch(effectLoop) {
case EffectLoop(var name, var volume) -> "Effect loop contains no eff
}
}
1
2
3
4
5

Array patterns
Array patterns
1
case EffectLoop(_, _, var effect) -> "Effect loop contains exactly on
1
2
3
4
5 }
6 }

Array patterns
Array patterns
1
case EffectLoop(_, _, var effect, ...) -> "Effect loop contains more
1
2
3
4
5
6 }
7 }

Array patterns
Array patterns
1
case EffectLoop(_, _, var effect, ...) -> "Effect loop contains more
case EffectLoop(_, _, var effect1, var effect2) -> "Effect loop conta
case EffectLoop(_, _, var effect1, var effect2, ...) -> "Effect loop
1
2
3
4
5
6
7
8 }
9 }

Other ideas
Other ideas
Deconstruction patterns for arbitrary classes
Enhanced array patterns
String[] { [8] -> var eighthElement, [9] -> var ninthElement}
AND patterns
Patterns in catch clauses
Collection patterns
https://mail.openjdk.java.net/pipermail/amber-spec-experts/2021-January/002758.html

Pattern
Pattern
Pattern
Pattern
Pattern
Contexts
Contexts
Contexts
Contexts
Contexts

Pattern Contexts
Pattern Contexts
Pattern
context
Example Purpose
instanceof
predicate
product instanceof
Guitar guitar
Test if target matches the
indicated pattern.
switch
statement or
expression
switch (effect) {
case Delay d ->
}
Test if target matches one (or
more) of the indicated patterns.
enhanced for for (Delay(int
timeInMs) : delays) {
}
Perform a iteration for each
target that matches the indicated
pattern.
bind
statement
__let Reverb(var
name, var roomSize) =
Destructure a target using a
pattern.

Wrap-up
Wrap-up
Wrap-up
Wrap-up
Wrap-up

Pattern matching...
Pattern matching...
is a rich feature arc that will play out over several
versions.
allows us to use type patterns in instanceof.
improves switch expressions.
makes destructuring objects as easy as (and more similar
to) constructing them.
holds the potential to simplify and streamline much of
the code we write today.

Major Feature
Major Feature
Major Feature
Major Feature
Major Feature

Thank you! 😀
Thank you! 😀
github.com/hannotify/pattern-
matching-music-store
hanno.codes peterwessels.nl
@hannotify @PeterWessels

Pattern Matching: Small Enhancement or Major Feature?

More Related Content

More from 🎤 Hanno Embregts 🎸 (12)

Recently uploaded (20)

Pattern Matching: Small Enhancement or Major Feature?