Package org.organicdesign.fp.oneOf

Class OneOf2OrNone<A,B>

java.lang.Object

org.organicdesign.fp.oneOf.OneOf2OrNone<A,B>

public abstract class OneOf2OrNone<A,B>
extends Object

Holds one of 2 values or None. See OneOf2 for a full description. If you're passing the same type, you probably want a tuple instead.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OneOf2OrNone(@Nullable Object o, @NotNull Class<A> aClass, @NotNull Class<B> bClass, int index)	Protected constructor for subclassing.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
int	hashCode()
<R> R	match(@NotNull Fn1<A,R> fa, @NotNull Fn1<B,R> fb, @NotNull Fn0<R> fz)	Languages that have union types built in have a match statement that works like this method.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OneOf2OrNone

protected OneOf2OrNone(@Nullable
                       @Nullable Object o,
                       @NotNull
                       @NotNull Class<A> aClass,
                       @NotNull
                       @NotNull Class<B> bClass,
                       int index)

Protected constructor for subclassing.

Parameters:

o - the item (may be null)

aClass - class 0 (to have at runtime for descriptive error messages and toString()).

bClass - class 1 (to have at runtime for descriptive error messages and toString()).

index - 0 means this represents an A, 1 represents a B, 2 represents a None

Method Detail

match

public <R> R match(@NotNull
                   @NotNull Fn1<A,R> fa,
                   @NotNull
                   @NotNull Fn1<B,R> fb,
                   @NotNull
                   @NotNull Fn0<R> fz)

Languages that have union types built in have a match statement that works like this method. Exactly one of these functions will be executed - determined by which type of item this object holds.

Parameters:

fa - the function to be executed if this OneOf stores the first type.

fb - the function to be executed if this OneOf stores the second type.

fz - the function to be executed if this OneOf stores a None.

Returns:

the return value of whichever function is executed.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object