com.aol.cyclops.types

Interface Combiner<T>

Type Parameters:

T - Data type of the element/s inside this Applicative

All Superinterfaces:

Convertable<T>, Foldable<T>, Functor<T>, java.lang.Iterable<T>, java.util.function.Predicate<T>, org.reactivestreams.Publisher<T>, java.util.function.Supplier<T>, Value<T>, Visitable<T>, Zippable<T>

All Known Subinterfaces:

AnyMValue<T>, ApplicativeFunctor<T>, Eval<T>, FeatureToggle<T>, Ior<ST,PT>, Maybe<T>, TransformerValue<T>, Try<T,X>, Xor<ST,PT>

All Known Implementing Classes:

AnyMValueImpl, CompletableFutureTValue, Eval.Module.Always, Eval.Module.Later, EvalTValue, FeatureToggle.Disabled, FeatureToggle.Enabled, FutureW, FutureWTValue, Ior.Both, Ior.Primary, Ior.Secondary, LazyImmutable, Maybe.Just, Maybe.Lazy, Maybe.Nothing, MaybeTValue, MonoTValue, OptionalTValue, Try.Failure, Try.Success, TryTValue, Xor.Primary, Xor.Secondary, XorTValue

public interface Combiner<T>
extends Functor<T>, Value<T>

Combinable type via BiFunctions / Monoids / Semigroups

Nested Class Summary

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

Value.ValueImpl<T>

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

Convertable.SupplierToConvertable<T>

Method Summary

Modifier and Type	Method and Description
default Combiner<T>	combine(java.util.function.BinaryOperator<Combiner<T>> combiner, Combiner<T> app) Combine two applicatives together using the provided BinaryOperator (Semigroup, Monoid and Reducer all extend BinaryOperator - checkout Semigroups and Monoids for a large number of canned combinations).
default <T2,R> Functor<R>	combine(Value<? extends T2> app, java.util.function.BiFunction<? super T,? super T2,? extends R> fn) Lazily combine this ApplicativeFunctor with the supplied value via the supplied BiFunction Example

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

cast, map, patternMatch, peek, trampoline

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

collect, fold, fold, generate, iterate, iterator, mapReduce, mkString, newSubscriber, of, stream, subscribe, test, toDequeX, toEvalAlways, toEvalLater, toEvalNow, toFeatureToggle, toFutureStream, toFutureStream, toIor, toLazyImmutable, toList, toListX, toMaybe, 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, isPresent, orElse, orElseGet, orElseThrow, toAtomicReference, toCompletableFuture, toCompletableFutureAsync, toCompletableFutureAsync, toFutureW, toFutureWAsync, toFutureWAsync, toOptional, toOptionalAtomicReference, toStream, visit

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

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

zip, zip, zip, zip, zip, zip, zip

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

combine

default <T2,R> Functor<R> combine(Value<? extends T2> app,
                                  java.util.function.BiFunction<? super T,? super T2,? extends R> fn)

Lazily combine this ApplicativeFunctor with the supplied value via the supplied BiFunction Example

  
   Maybe<Integer> some = Maybe.just(10);
   just.combine(Eval.now(20), this::add);
   //Some[30]
   
   Maybe<Integer> none = Maybe.none();
   none.combine(Eval.now(20), this::add);
   //None
   
 
 

Parameters:

app - Value to combine with this one.

fn - BiFunction to combine them

Returns:

New Applicativefunctor that represents the combined values

combine

default Combiner<T> combine(java.util.function.BinaryOperator<Combiner<T>> combiner,
                            Combiner<T> app)

Combine two applicatives together using the provided BinaryOperator (Semigroup, Monoid and Reducer all extend BinaryOperator - checkout Semigroups and Monoids for a large number of canned combinations). If this Applicative is a scalar value the provided value is combined with that value, otherwise the value is combined pair wise with all value in a non-scalar datastructure

Parameters:

combiner -

app -

Returns:

See Also:

Semigroup, Semigroups, Monoid, To lift any Semigroup (or monoid) up to handling Applicatives use the combineApplicatives operator in Semigroups {@see com.aol.cyclops.Semigroups#combineApplicatives(BiFunction) } or Monoids { {@see com.aol.cyclops.Monoids#combineApplicatives(java.util.function.Function, com.aol.cyclops.Monoid) }

 {@code 
 
   
  BinaryOperator> sumMaybes = Semigroups.combineScalarFunctors(Semigroups.intSum);
        Maybe.just(1)
            .combine(sumMaybes, Maybe.just(5))
        //Maybe.just(6));
 }