Package de.xima.fc.common.data.algebraic

Class OneOfN.Just<T1>

java.lang.Object

de.xima.fc.common.data.algebraic.OneOfN

de.xima.fc.common.data.algebraic.OneOfN.Just<T1>

Type Parameters:

T1 - Type of the value for the first case.

All Implemented Interfaces:

Serializable

Enclosing class:

OneOfN

public static final class OneOfN.Just<T1>
extends OneOfN

Emulates a sum type consisting of 1 case.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.xima.fc.common.data.algebraic.OneOfN

OneOfN.Either<T1,T2>, OneOfN.EitherMatcher<R,T1,T2>, OneOfN.Just<T1>, OneOfN.JustMatcher<R,T1>, OneOfN.None, OneOfN.NoneMatcher<R>, OneOfN.OneOf3<T1,T2,T3>, OneOfN.OneOf3Matcher<R,T1,T2,T3>, OneOfN.OneOf4<T1,T2,T3,T4>, OneOfN.OneOf4Matcher<R,T1,T2,T3,T4>, OneOfN.OneOf5<T1,T2,T3,T4,T5>, OneOfN.OneOf5Matcher<R,T1,T2,T3,T4,T5>

Field Summary

Fields inherited from class de.xima.fc.common.data.algebraic.OneOfN

choice, value

Method Summary

Modifier and Type	Method	Description
static <T1> OneOfN.Just<T1>	first(T1 first)
T1	getValue()	Checks which case applies and returns the value for that case.
boolean	isFirst()
<R> R	match(Function<T1,R> first)	Performs a case match on this sum type by invoking the mapping function for the matching case with the value of this sum type and returning the result.
<R> R	match(R defaultValue, OneOfN.JustMatcher<R,T1> matcher)	Performs a case match on this sum type by invoking the mapping function for the matching case with the value of this sum type and returning the result.
Optional<T1>	selectFirst()

Methods inherited from class de.xima.fc.common.data.algebraic.OneOfN

equals, getChoice, hashCode, is, select

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public T1 getValue()

Description copied from class: OneOfN

Checks which case applies and returns the value for that case. You need to cast it yourself to the required type.

Overrides:

getValue in class OneOfN

Returns:

The value of this sum type.

isFirst

public boolean isFirst()

Returns:

Whether a value for the first case is present.

match

public <R> R match(R defaultValue,
                   OneOfN.JustMatcher<R,T1> matcher)

Performs a case match on this sum type by invoking the mapping function for the matching case with the value of this sum type and returning the result.

Type Parameters:

R - Type of the result returned by each mapping function.

Parameters:

defaultValue - Value returned when the given matcher has no matching case.

matcher - Matcher object for each case.

Returns:

The value returned by the mapping function for the matching case.

match

public <R> R match(Function<T1,R> first)

Performs a case match on this sum type by invoking the mapping function for the matching case with the value of this sum type and returning the result.

Type Parameters:

R - Type of the result returned by each mapping function.

Parameters:

first - Mapping function for the first case.

Returns:

The value returned by the mapping function for the matching case.

selectFirst

public Optional<T1> selectFirst()

Returns:

The value of the first case, if a value exists for that case.

first

public static <T1> OneOfN.Just<T1> first(T1 first)

Parameters:

first - The value for the first case.

Returns:

A new sum type with the value for the first case.