com.bluegosling.choice

Interface Choice.OfTwo<A,B>

Type Parameters:

A - the type of the first option

B - the type of the second option

All Superinterfaces:

Choice<A,B>

All Known Implementing Classes:

Either, Union2

Enclosing interface:

Choice<A,B>

public static interface Choice.OfTwo<A,B>
extends Choice<A,B>

Operations for a Choice that has exactly two options.

Nested Class Summary

Nested classes/interfaces inherited from interface com.bluegosling.choice.Choice

Choice.OfFive<A,B,C,D,E>, Choice.OfFour<A,B,C,D>, Choice.OfThree<A,B,C>, Choice.OfTwo<A,B>, Choice.Ops3<A,B,C>, Choice.Ops4<A,B,C,D>, Choice.Ops5<A,B,C,D,E>, Choice.VisitorOfFive<A,B,C,D,E,R>, Choice.VisitorOfFour<A,B,C,D,R>, Choice.VisitorOfThree<A,B,C,R>, Choice.VisitorOfTwo<A,B,R>

Method Summary

Modifier and Type	Method and Description
<C> Choice.OfThree<C,A,B>	expandFirst() Expands this choice of two options into a choice of three options whose first option is never present.
<C> Choice.OfThree<A,C,B>	expandSecond() Expands this choice of two options into a choice of three options whose second option is never present.
<C> Choice.OfThree<A,B,C>	expandThird() Expands this choice of two options into a choice of three options whose third option is never present.
<T> Choice.OfTwo<T,B>	mapFirst(Function<? super A,? extends T> function) Transforms the value of the first option.
<T> Choice.OfTwo<A,T>	mapSecond(Function<? super B,? extends T> function) Transforms the value of the second option.
<R> R	visit(Choice.VisitorOfTwo<? super A,? super B,R> visitor) Invokes the appropriate visit method on the given visitor.

Methods inherited from interface com.bluegosling.choice.Choice

get, getFirst, getSecond, hasFirst, hasSecond, tryFirst, trySecond

Method Detail

visit

<R> R visit(Choice.VisitorOfTwo<? super A,? super B,R> visitor)

Invokes the appropriate visit method on the given visitor. For example, if this choice has the first option present, then Choice.VisitorOfTwo.visitFirst(Object) will be invoked.

Type Parameters:

R - the type of result from visiting

Parameters:

visitor - the visitor

Returns:

the value returned by the given visitor

expandFirst

<C> Choice.OfThree<C,A,B> expandFirst()

Expands this choice of two options into a choice of three options whose first option is never present. The new choice will have the same value as this choice. Whichever option is present in this choice will have its position shifted to the corresponding option of the new choice.

Type Parameters:

C - the type of an absent first option in the expanded choice

Returns:

a choice of three options with the same value as this and whose first option is never present

expandSecond

<C> Choice.OfThree<A,C,B> expandSecond()

Expands this choice of two options into a choice of three options whose second option is never present. The new choice will have the same value as this choice. Whichever option is present in this choice will have its position shifted to the corresponding option of the new choice.

Type Parameters:

C - the type of an absent second option in the expanded choice

Returns:

a choice of three options with the same value as this and whose second option is never present

expandThird

<C> Choice.OfThree<A,B,C> expandThird()

Expands this choice of two options into a choice of three options whose third option is never present. The new choice will have the same value as this choice. Whichever option is present in this choice will also be present in the new choice.

Type Parameters:

C - the type of an absent third option in the expanded choice

Returns:

a choice of three options with the same value as this and whose third option is never present

mapFirst

<T> Choice.OfTwo<T,B> mapFirst(Function<? super A,? extends T> function)

Description copied from interface: Choice

Transforms the value of the first option. If the first option is not present, this effectively does nothing. If the first option is present, the given function is applied to its value and a new choice is returned whose first option is the function's result.

Specified by:

mapFirst in interface Choice<A,B>

Parameters:

function - the function to apply to the first option

Returns:

a choice with the first option, it it was present, transformed by applying the given function to it

mapSecond

<T> Choice.OfTwo<A,T> mapSecond(Function<? super B,? extends T> function)

Description copied from interface: Choice

Transforms the value of the second option. If the second option is not present, this effectively does nothing. If the second option is present, the given function is applied to its value and a new choice is returned whose second option is the function's result.

Specified by:

mapSecond in interface Choice<A,B>

Parameters:

function - the function to apply to the second option

Returns:

a choice with the second option, it it was present, transformed by applying the given function to it