Package io.vavr

Class API.Match<T>

java.lang.Object

io.vavr.API.Match<T>

Type Parameters:

T - type of the object that is matched

Enclosing class:

API

@GwtIncompatible
public static final class API.Match<T>
extends Object

Scala-like structural pattern matching for Java. Instances are obtained via API.Match(Object).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	API.Match.Case<T,R>	Base interface for all the Cases
static final class	API.Match.Case0<T,R>	API.Match.Case implementation for simplest case
static final class	API.Match.Case1<T,T1,R>	API.Match.Case implementation for a case with 1 intermediate type
static final class	API.Match.Case2<T,T1,T2,R>	API.Match.Case implementation for a case with 2 intermediate types
static final class	API.Match.Case3<T,T1,T2,T3,R>	API.Match.Case implementation for a case with 3 intermediate types
static final class	API.Match.Case4<T,T1,T2,T3,T4,R>	API.Match.Case implementation for a case with 4 intermediate types
static final class	API.Match.Case5<T,T1,T2,T3,T4,T5,R>	API.Match.Case implementation for a case with 5 intermediate types
static final class	API.Match.Case6<T,T1,T2,T3,T4,T5,T6,R>	API.Match.Case implementation for a case with 6 intermediate types
static final class	API.Match.Case7<T,T1,T2,T3,T4,T5,T6,T7,R>	API.Match.Case implementation for a case with 7 intermediate types
static final class	API.Match.Case8<T,T1,T2,T3,T4,T5,T6,T7,T8,R>	API.Match.Case implementation for a case with 8 intermediate types
static interface	API.Match.Pattern<T,R>	A Pattern is a partial Function in the sense that a function applications returns an optional result of type Option<R>.
static class	API.Match.Pattern0<T>	A API.Match.Pattern implementation for the simplest pattern
static class	API.Match.Pattern1<T,T1>	A API.Match.Pattern implementation for the pattern with 1 intermediate type
static class	API.Match.Pattern2<T,T1,T2>	A API.Match.Pattern implementation for the pattern with 2 intermediate types
static class	API.Match.Pattern3<T,T1,T2,T3>	A API.Match.Pattern implementation for the pattern with 3 intermediate types
static class	API.Match.Pattern4<T,T1,T2,T3,T4>	A API.Match.Pattern implementation for the pattern with 4 intermediate types
static class	API.Match.Pattern5<T,T1,T2,T3,T4,T5>	A API.Match.Pattern implementation for the pattern with 5 intermediate types
static class	API.Match.Pattern6<T,T1,T2,T3,T4,T5,T6>	A API.Match.Pattern implementation for the pattern with 6 intermediate types
static class	API.Match.Pattern7<T,T1,T2,T3,T4,T5,T6,T7>	A API.Match.Pattern implementation for the pattern with 7 intermediate types
static class	API.Match.Pattern8<T,T1,T2,T3,T4,T5,T6,T7,T8>	A API.Match.Pattern implementation for the pattern with 8 intermediate types

Field Summary

Fields

Modifier and Type	Field	Description
private final T	value

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Match(T value)

Method Summary

Modifier and Type	Method	Description
final <R> R	of(@NonNull API.Match.Case<? extends T,? extends R> @NonNull ... cases)	Executes the match, created by the factory function API.Match(Object).
final <R> Option<R>	option(@NonNull API.Match.Case<? extends T,? extends R> @NonNull ... cases)	Executes the match, created by the factory function API.Match(Object).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

value

private final T value

Constructor Details

Match

private Match(T value)

Method Details

of

@SafeVarargs
public final <R> R of(@NonNull API.Match.Case<? extends T,? extends R> @NonNull ... cases)

Executes the match, created by the factory function API.Match(Object). Throws exceptions when the list of API.Match.Cases is incomplete.

Type Parameters:

R - return value type

Parameters:

cases - list of cases we execute the match against

Returns:

The matched value

Throws:

MatchError - if the list of cases was not defined for all possible values of T

option

@SafeVarargs
public final <R> Option<R> option(@NonNull API.Match.Case<? extends T,? extends R> @NonNull ... cases)

Executes the match, created by the factory function API.Match(Object). Returns Option.some(...) if the value was matched and Option.none() otherwise.

Type Parameters:

R - return value type

Parameters:

cases - list of cases we execute the match against

Returns:

Option containing the matched value, or none