cyclops.companion

Class Optionals.OptionalKind<T>

java.lang.Object

cyclops.companion.Optionals.OptionalKind<T>

Type Parameters:

T - Data type stored within the Optional

All Implemented Interfaces:

Convert<Higher<Witness.optional,T>>, Higher<Witness.optional,T>

Enclosing class:

Optionals

public static final class Optionals.OptionalKind<T>
extends java.lang.Object
implements Higher<Witness.optional,T>

Simulates Higher Kinded Types for Optional's OptionalKind is a Optional and a Higher Kinded Type (optional,T)

Constructor Summary

Constructors

Constructor and Description
OptionalKind()

Method Summary

Modifier and Type	Method and Description
Active<Witness.optional,T>	allTypeclasses()
static <T> Optionals.OptionalKind<T>	empty()
boolean	equals(java.lang.Object obj)
Optionals.OptionalKind<T>	filter(java.util.function.Predicate<? super T> predicate)
<U> java.util.Optional<U>	flatMap(java.util.function.Function<? super T,java.util.Optional<U>> mapper)
T	get()
int	hashCode()
void	ifPresent(java.util.function.Consumer<? super T> consumer)
boolean	isPresent()
<U> Optionals.OptionalKind<U>	map(java.util.function.Function<? super T,? extends U> mapper)
<W2,R> Nested<Witness.optional,W2,R>	mapM(java.util.function.Function<? super T,? extends Higher<W2,R>> fn, InstanceDefinitions<W2> defs)
static <T> Optionals.OptionalKind<T>	narrow(Higher<Witness.optional,T> future) Convert the raw Higher Kinded Type for OptionalKind types into the OptionalKind type definition class
static <T> java.util.Optional<T>	narrowK(Higher<Witness.optional,T> Optional) Convert the HigherKindedType definition for a Optional into
static <T> Optionals.OptionalKind<T>	of(T value)
static <T> Optionals.OptionalKind<T>	ofNullable(T value)
T	orElse(T other)
T	orElseGet(java.util.function.Supplier<? extends T> other)
<X extends java.lang.Throwable> T	orElseThrow(java.util.function.Supplier<? extends X> exceptionSupplier)
java.lang.String	toString()
static <T> Optionals.OptionalKind<T>	widen(java.util.Optional<T> Optional) Convert a Optional to a simulated HigherKindedType that captures Optional nature and Optional element data type separately.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aol.cyclops2.hkt.Higher

applyHKT_, applyHKT, applyHKT

Methods inherited from interface com.aol.cyclops2.hkt.Convert

convert

Constructor Detail

OptionalKind

public OptionalKind()

Method Detail

empty

public static <T> Optionals.OptionalKind<T> empty()

Returns:

An HKT encoded zero Optional

of

public static <T> Optionals.OptionalKind<T> of(T value)

Parameters:

value - Value to embed in an Optional

Returns:

An HKT encoded Optional

ofNullable

public static <T> Optionals.OptionalKind<T> ofNullable(T value)

widen

public static <T> Optionals.OptionalKind<T> widen(java.util.Optional<T> Optional)

Convert a Optional to a simulated HigherKindedType that captures Optional nature and Optional element data type separately. Recover via @see OptionalKind#narrow If the supplied Optional implements OptionalKind it is returned already, otherwise it is wrapped into a Optional implementation that does implement OptionalKind

Parameters:

Optional - Optional to widen to a OptionalKind

Returns:

OptionalKind encoding HKT info about Optionals

narrow

public static <T> Optionals.OptionalKind<T> narrow(Higher<Witness.optional,T> future)

Convert the raw Higher Kinded Type for OptionalKind types into the OptionalKind type definition class

Parameters:

future - HKT encoded list into a OptionalKind

Returns:

OptionalKind

narrowK

public static <T> java.util.Optional<T> narrowK(Higher<Witness.optional,T> Optional)

Convert the HigherKindedType definition for a Optional into

Parameters:

Optional - Type Constructor to convert back into narrowed type

Returns:

Optional from Higher Kinded Type

isPresent

public boolean isPresent()

get

public T get()

ifPresent

public void ifPresent(java.util.function.Consumer<? super T> consumer)

filter

public Optionals.OptionalKind<T> filter(java.util.function.Predicate<? super T> predicate)

map

public <U> Optionals.OptionalKind<U> map(java.util.function.Function<? super T,? extends U> mapper)

flatMap

public <U> java.util.Optional<U> flatMap(java.util.function.Function<? super T,java.util.Optional<U>> mapper)

orElse

public T orElse(T other)

orElseGet

public T orElseGet(java.util.function.Supplier<? extends T> other)

orElseThrow

public <X extends java.lang.Throwable> T orElseThrow(java.util.function.Supplier<? extends X> exceptionSupplier)
                                              throws X extends java.lang.Throwable

Throws:

X extends java.lang.Throwable

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

allTypeclasses

public Active<Witness.optional,T> allTypeclasses()

mapM

public <W2,R> Nested<Witness.optional,W2,R> mapM(java.util.function.Function<? super T,? extends Higher<W2,R>> fn,
                                                 InstanceDefinitions<W2> defs)