com.aol.cyclops.hkt.instances

Class General.SupplierMonadPlus<CRE,T,B>

java.lang.Object

com.aol.cyclops.hkt.instances.General.SupplierMonadPlus<CRE,T,B>

All Implemented Interfaces:

Filterable<CRE>, Functor<CRE>, Applicative<CRE>, Monad<CRE>, MonadPlus<CRE>, MonadZero<CRE>, Unit<CRE>

Enclosing interface:

General

public static class General.SupplierMonadPlus<CRE,T,B>
extends java.lang.Object
implements MonadPlus<CRE>

Constructor Summary

Constructors

Constructor and Description
SupplierMonadPlus()

Method Summary

Modifier and Type	Method and Description
<T,R> com.aol.cyclops.hkt.alias.Higher<CRE,R>	ap(com.aol.cyclops.hkt.alias.Higher<CRE,java.util.function.Function<T,R>> fn, com.aol.cyclops.hkt.alias.Higher<CRE,T> apply)
<T,R> com.aol.cyclops.hkt.alias.Higher<CRE,R>	flatMap(java.util.function.Function<? super T,? extends com.aol.cyclops.hkt.alias.Higher<CRE,R>> fn, com.aol.cyclops.hkt.alias.Higher<CRE,T> ds)
<T,R> com.aol.cyclops.hkt.alias.Higher<CRE,R>	map(java.util.function.Function<? super T,? extends R> fn, com.aol.cyclops.hkt.alias.Higher<CRE,T> ds) Transform the supplied data structure using the supplied transformation function
com.aol.cyclops.Monoid<com.aol.cyclops.hkt.alias.Higher<CRE,?>>	monoid()
<T> com.aol.cyclops.hkt.alias.Higher<CRE,T>	unit(T value) Create a new instance of the core type (e.g.
com.aol.cyclops.hkt.alias.Higher<CRE,?>	zero() e.g.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aol.cyclops.hkt.typeclasses.monad.MonadPlus

narrowMonoid, plus

Methods inherited from interface com.aol.cyclops.hkt.typeclasses.monad.MonadZero

filter, narrowZero

Methods inherited from interface com.aol.cyclops.hkt.typeclasses.monad.Monad

flatten, mapM, replicate, sequence, traverse

Methods inherited from interface com.aol.cyclops.hkt.typeclasses.monad.Applicative

ap2, ap3, apBiFn, curry2, narrow, narrow2, narrow3, narrowBiFn

Methods inherited from interface com.aol.cyclops.hkt.typeclasses.functor.Functor

lift, mapRev, peek

Constructor Detail

SupplierMonadPlus

public SupplierMonadPlus()

Method Detail

flatMap

public <T,R> com.aol.cyclops.hkt.alias.Higher<CRE,R> flatMap(java.util.function.Function<? super T,? extends com.aol.cyclops.hkt.alias.Higher<CRE,R>> fn,
                                                             com.aol.cyclops.hkt.alias.Higher<CRE,T> ds)

Specified by:

flatMap in interface Monad<CRE>

ap

public <T,R> com.aol.cyclops.hkt.alias.Higher<CRE,R> ap(com.aol.cyclops.hkt.alias.Higher<CRE,java.util.function.Function<T,R>> fn,
                                                        com.aol.cyclops.hkt.alias.Higher<CRE,T> apply)

Specified by:

ap in interface Applicative<CRE>

map

public <T,R> com.aol.cyclops.hkt.alias.Higher<CRE,R> map(java.util.function.Function<? super T,? extends R> fn,
                                                         com.aol.cyclops.hkt.alias.Higher<CRE,T> ds)

Description copied from interface: Functor

Transform the supplied data structure using the supplied transformation function

  
  ListX<Integer> listx = ListX.of(1,2,3);
        ListType<Integer> mapped1 =Lists.functor().map(a->a+1, ListType.widen(listx));
        mapped1.add(1);
        ListX<Integer> listxMapped = mapped1.list();
 
 

Specified by:

map in interface Functor<CRE>

Parameters:

fn - Transformation function

ds - Datastructure to transform

Returns:

unit

public <T> com.aol.cyclops.hkt.alias.Higher<CRE,T> unit(T value)

Description copied from interface: Unit

Create a new instance of the core type (e.g. a List or CompletableFuture) that is HKT encoded

Specified by:

unit in interface Unit<CRE>

Parameters:

value - To populate new instance of

Returns:

HKT encoded new instance with supplied value

zero

public com.aol.cyclops.hkt.alias.Higher<CRE,?> zero()

Description copied from interface: MonadZero

e.g. for Optional we can use Optional.empty()

Specified by:

zero in interface MonadPlus<CRE>

Specified by:

zero in interface MonadZero<CRE>

Returns:

Identity value or zero value for the HKT type, the generic type is unknown

monoid

public com.aol.cyclops.Monoid<com.aol.cyclops.hkt.alias.Higher<CRE,?>> monoid()

Specified by:

monoid in interface MonadPlus<CRE>