com.aol.cyclops.hkt.cyclops

Interface MaybeType<T>

Type Parameters:

T - Data type stored within the Maybe

All Superinterfaces:

org.derive4j.hkt.__<MaybeType.µ,T>, com.aol.cyclops.types.applicative.ApplicativeFunctor<T>, com.aol.cyclops.types.Combiner<T>, com.aol.cyclops.hkt.alias.Convert<com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T>>, com.aol.cyclops.types.Convertable<T>, com.aol.cyclops.types.ConvertableFunctor<T>, com.aol.cyclops.types.Filterable<T>, com.aol.cyclops.types.Foldable<T>, com.aol.cyclops.types.Functor<T>, com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T>, java.lang.Iterable<T>, com.aol.cyclops.control.Matchable.MatchableOptional<T>, com.aol.cyclops.control.Matchable.ValueAndOptionalMatcher<T>, com.aol.cyclops.control.Maybe<T>, com.aol.cyclops.types.MonadicValue<T>, com.aol.cyclops.types.MonadicValue1<T>, java.util.function.Predicate<T>, org.reactivestreams.Publisher<T>, java.util.function.Supplier<T>, com.aol.cyclops.types.To<com.aol.cyclops.control.Maybe<T>>, com.aol.cyclops.types.Unit<T>, com.aol.cyclops.types.Value<T>, com.aol.cyclops.types.Visitable<T>, com.aol.cyclops.types.Zippable<T>

All Known Implementing Classes:

MaybeType.Box

public interface MaybeType<T>
extends com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T>, com.aol.cyclops.control.Maybe<T>

Simulates Higher Kinded Types for Maybe's MaybeType is a Maybe and a Higher Kinded Type (MaybeType.µ,T)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MaybeType.µ Witness type
static class	MaybeType.Box<T>

Nested classes/interfaces inherited from interface com.aol.cyclops.control.Maybe

com.aol.cyclops.control.Maybe.Just<T>, com.aol.cyclops.control.Maybe.Lazy<T>, com.aol.cyclops.control.Maybe.Nothing<T>

Nested classes/interfaces inherited from interface com.aol.cyclops.types.applicative.ApplicativeFunctor

com.aol.cyclops.types.applicative.ApplicativeFunctor.Applicatives, com.aol.cyclops.types.applicative.ApplicativeFunctor.ApplyFunctions<T>

Nested classes/interfaces inherited from interface com.aol.cyclops.types.Value

com.aol.cyclops.types.Value.ValueImpl<T>

Nested classes/interfaces inherited from interface com.aol.cyclops.types.Convertable

com.aol.cyclops.types.Convertable.SupplierToConvertable<T>

Field Summary

Fields inherited from interface com.aol.cyclops.control.Maybe

EMPTY

Method Summary

Modifier and Type	Method and Description
static <T> MaybeType<T>	fromOptional(com.aol.cyclops.hkt.alias.Higher<com.aol.cyclops.hkt.jdk.OptionalType.µ,T> optional) Construct an equivalent Maybe from the Supplied Optional
static <X extends java.lang.Throwable,T> MaybeType<T>	fromXor(com.aol.cyclops.control.Try<T,X> ty)
static <ST,T> MaybeType<T>	fromXor(com.aol.cyclops.control.Xor<ST,T> xor)
static <T> MaybeType<T>	just(T value) Construct an Maybe which contains the provided (non-null) value.
static <T> com.aol.cyclops.control.Maybe<T>	narrow(com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T> maybe) Convert the HigherKindedType definition for a Maybe into
static <T> MaybeType<T>	narrowK(com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T> future) Convert the raw Higher Kinded Type for MaybeType types into the MaybeType type definition class
static <T> java.util.Optional<T>	narrowOptional(com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T> Optional) Convert the HigherKindedType definition for a Maybe into
static <T> MaybeType<T>	none()
static <T> MaybeType<T>	of(T value) Construct an Maybe which contains the provided (non-null) value Equivalent to @see Maybe.just(Object)
static <T> MaybeType<T>	ofNullable(T value) Maybe<Integer> maybe = Maybe.ofNullable(null); //None Maybe<Integer> maybe = Maybe.ofNullable(10); //Maybe[10], Some[10]
static <T> MaybeType<T>	widen(com.aol.cyclops.control.Maybe<T> maybe) Convert a Maybe to a simulated HigherKindedType that captures Maybe nature and Maybe element data type separately.
static <T> MaybeType<T>	widen(java.util.Optional<T> optional) Convert a Optional to a simulated HigherKindedType that captures Optional nature and Optional element data type separately.
static <C2,T> com.aol.cyclops.hkt.alias.Higher<C2,com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T>>	widen2(com.aol.cyclops.hkt.alias.Higher<C2,MaybeType<T>> nestedMaybe)

Methods inherited from interface com.aol.cyclops.hkt.alias.Higher

apply_, apply, then

Methods inherited from interface com.aol.cyclops.hkt.alias.Convert

convert

Methods inherited from interface com.aol.cyclops.control.Maybe

accumulateJust, accumulateJust, accumulateJust, cast, coflatMap, combine, combine, combineEager, filter, filterNot, flatMap, flatMapIterable, flatMapPublisher, fromEval, fromEvalOf, fromIterable, fromOptional, fromPublisher, isPresent, map, narrow, nest, notNull, ofType, patternMatch, peek, recover, recover, sequence, sequence, sequenceJust, toMaybe, trampoline, unit, visit, zip, zip, zip, zip, zip, zip, zip

Methods inherited from interface com.aol.cyclops.types.To

to

Methods inherited from interface com.aol.cyclops.types.MonadicValue1

anyM

Methods inherited from interface com.aol.cyclops.types.applicative.ApplicativeFunctor

applyFunctions

Methods inherited from interface com.aol.cyclops.types.Value

collect, fold, fold, generate, iterate, iterator, mapReduce, mkString, newSubscriber, stream, subscribe, test, toDequeX, toEvalAlways, toEvalLater, toEvalNow, toFeatureToggle, toFutureStream, toFutureStream, toIor, toLazyImmutable, toList, toListX, toMutable, toPBagX, toPOrderedSetX, toPQueueX, toPSetX, toPStackX, toPVectorX, toQueueX, toSetX, toSimpleReact, toSimpleReact, toSortedSetX, toTry, toTry, toTry, toXor, toXor, unapply

Methods inherited from interface com.aol.cyclops.types.Foldable

endsWith, endsWithIterable, findAny, findFirst, firstValue, foldable, foldRight, foldRight, foldRight, foldRightMapToType, get, groupBy, join, join, join, mapReduce, print, print, printErr, printOut, reduce, reduce, reduce, reduce, reduce, reduce, reduce, schedule, scheduleFixedDelay, scheduleFixedRate, single, single, singleOptional, startsWith, startsWithIterable, toConcurrentLazyCollection, toConcurrentLazyStreamable, toLazyCollection, validate, xMatch

Methods inherited from interface com.aol.cyclops.types.Convertable

collect, fromSupplier, get, orElse, orElseGet, orElseThrow, toAtomicReference, toCompletableFuture, toCompletableFutureAsync, toCompletableFutureAsync, toFutureW, toFutureWAsync, toFutureWAsync, toOptional, toOptionalAtomicReference, toStream

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.aol.cyclops.control.Matchable.ValueAndOptionalMatcher

iterator, toOptional

Methods inherited from interface com.aol.cyclops.control.Matchable.MatchableOptional

matches

Method Detail

fromXor

static <ST,T> MaybeType<T> fromXor(com.aol.cyclops.control.Xor<ST,T> xor)

fromXor

static <X extends java.lang.Throwable,T> MaybeType<T> fromXor(com.aol.cyclops.control.Try<T,X> ty)

none

static <T> MaybeType<T> none()

Specified by:

none in interface com.aol.cyclops.control.Maybe<T>

Returns:

Get the empty Maybe (single instance)

fromOptional

static <T> MaybeType<T> fromOptional(com.aol.cyclops.hkt.alias.Higher<com.aol.cyclops.hkt.jdk.OptionalType.µ,T> optional)

Construct an equivalent Maybe from the Supplied Optional

  
   MaybeType<Integer> some = MaybeType.fromOptional(Optional.of(10));
   //Maybe[10], Some[10]
  
   MaybeType<Integer> none = MaybeType.fromOptional(Optional.empty());
   //Maybe.empty, None[]
 
 

Parameters:

opt - Optional to construct Maybe from

Returns:

Maybe created from Optional

widen

static <T> MaybeType<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 OptionalType#narrow If the supplied Optional implements OptionalType it is returned already, otherwise it is wrapped into a Optional implementation that does implement OptionalType

Parameters:

Optional - Optional to widen to a MaybeType

Returns:

MaybeType encoding HKT info about Optionals (converts Optional to a Maybe)

widen2

static <C2,T> com.aol.cyclops.hkt.alias.Higher<C2,com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T>> widen2(com.aol.cyclops.hkt.alias.Higher<C2,MaybeType<T>> nestedMaybe)

narrowK

static <T> MaybeType<T> narrowK(com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T> future)

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

Parameters:

future - HKT encoded list into a MaybeType

Returns:

MaybeType

narrowOptional

static <T> java.util.Optional<T> narrowOptional(com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T> Optional)

Convert the HigherKindedType definition for a Maybe into

Parameters:

MaybeType - Constructor to convert back into narrowed type

Returns:

Optional from Higher Kinded Type

just

static <T> MaybeType<T> just(T value)

Construct an Maybe which contains the provided (non-null) value. Alias for @see Maybe.of(Object)

  
 
    Maybe<Integer> some = Maybe.just(10);
    some.map(i->i*2);
 
 

Specified by:

just in interface com.aol.cyclops.control.Maybe<T>

Parameters:

value - Value to wrap inside a Maybe

Returns:

Maybe containing the supplied value

of

static <T> MaybeType<T> of(T value)

Construct an Maybe which contains the provided (non-null) value Equivalent to @see Maybe.just(Object)

  
 
    Maybe<Integer> some = Maybe.of(10);
    some.map(i->i*2);
 
 

Specified by:

of in interface com.aol.cyclops.control.Maybe<T>

Specified by:

of in interface com.aol.cyclops.types.Value<T>

Parameters:

value - Value to wrap inside a Maybe

Returns:

Maybe containing the supplied value

ofNullable

static <T> MaybeType<T> ofNullable(T value)

  
    Maybe<Integer> maybe  = Maybe.ofNullable(null);
    //None
     
    Maybe<Integer> maybe = Maybe.ofNullable(10);
    //Maybe[10], Some[10]
 
 
 

Specified by:

ofNullable in interface com.aol.cyclops.control.Maybe<T>

Parameters:

value -

Returns:

widen

static <T> MaybeType<T> widen(com.aol.cyclops.control.Maybe<T> maybe)

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

Parameters:

Maybe - Maybe to widen to a MaybeType

Returns:

MaybeType encoding HKT info about Maybes

narrow

static <T> com.aol.cyclops.control.Maybe<T> narrow(com.aol.cyclops.hkt.alias.Higher<MaybeType.µ,T> maybe)

Convert the HigherKindedType definition for a Maybe into

Parameters:

Maybe - Type Constructor to convert back into narrowed type

Returns:

MaybeX from Higher Kinded Type