com.aol.cyclops2.types

Interface Zippable<T>

Type Parameters:

T - Data type of element(s) of this Zippable

All Superinterfaces:

java.lang.Iterable<T>, Transformable<T>

All Known Subinterfaces:

AnyM<W,T>, AnyM2<W,T,T2>, AnyMSeq<W,T>, AnyMValue<W,T>, BagX<T>, CollectionX<T>, DequeX<T>, Either<LT,RT>, Either3<LT1,LT2,RT>, Either4<LT1,LT2,LT3,RT>, Either5<LT1,LT2,LT3,LT4,RT>, Eval<T>, ExtendedTraversable<T>, FluentCollectionX<T>, FoldableTransformerSeq<W,T>, FoldableTraversable<T>, FutureStream<U>, IndexedSequenceX<T>, Ior<ST,PT>, LazyCollectionX<T>, LazyFluentCollectionX<T>, LinkedListX<T>, ListX<T>, Maybe<T>, MonadicValue<T>, MutableSequenceX<T>, OrderedSetX<T>, PersistentQueueX<T>, PersistentSetX<T>, QueueX<T>, ReactiveSeq<T>, SetX<T>, SortedSetX<T>, Streamable<T>, TransformerSeq<W,T>, Traversable<T>, Try<T,X>, VectorX<T>, Xor<ST,PT>

All Known Implementing Classes:

AbstractLazyCollection, AbstractLazyPersistentCollection, CollectionXImpl, CompletableFutureT, Either.CompletableEither, Either.Lazy, Either.Left, Either.Right, Either3.CompletableEither3, Either3.Lazy, Either3.Left1, Either3.Left2, Either3.Right, Either4.CompletableEither4, Either4.Lazy, Either4.Left1, Either4.Left2, Either4.Left3, Either4.Right, Either5.CompletableEither5, Either5.Lazy, Either5.Left1, Either5.Left2, Either5.Left3, Either5.Left4, Either5.Right, Eval.CompletableEval, Eval.Module.Always, Eval.Module.FutureAlways, Eval.Module.Later, EvalT, Future, FutureT, Ior.Both, Ior.Primary, Ior.Secondary, LazyDequeX, LazyImmutable, LazyLinkedListX, LazyListX, LazyPBagX, LazyPOrderedSetX, LazyPQueueX, LazyPSetX, LazyPVectorX, LazyQueueX, LazySetX, LazySortedSetX, ListT, Maybe.CompletableMaybe, Maybe.Just, Maybe.Lazy, Maybe.Nothing, MaybeT, OptionalT, StreamT, Try.Failure, Try.Success, ValueTransformer, Xor.Primary, Xor.Secondary

public interface Zippable<T>
extends java.lang.Iterable<T>, Transformable<T>

A Data Type that can be comined with another data type

Method Summary

Modifier and Type	Method and Description
default Zippable<T>	zip(java.util.function.BinaryOperator<Zippable<T>> combiner, Zippable<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> Zippable<R>	zip(java.lang.Iterable<? extends T2> iterable, java.util.function.BiFunction<? super T,? super T2,? extends R> fn) Zip (combine) this Zippable with the supplied Iterable using the supplied combining function
default <U> Zippable<org.jooq.lambda.tuple.Tuple2<T,U>>	zip(java.lang.Iterable<? extends U> other) Zip (combine) this Zippable with the supplied Iterable combining both into a Tuple2
default <S,U> Zippable<org.jooq.lambda.tuple.Tuple3<T,S,U>>	zip3(java.lang.Iterable<? extends S> second, java.lang.Iterable<? extends U> third) zip 3 Streams into one
default <S,U,R> Zippable<R>	zip3(java.lang.Iterable<? extends S> second, java.lang.Iterable<? extends U> third, Fn3<? super T,? super S,? super U,? extends R> fn3)
default <T2,T3,T4> Zippable<org.jooq.lambda.tuple.Tuple4<T,T2,T3,T4>>	zip4(java.lang.Iterable<? extends T2> second, java.lang.Iterable<? extends T3> third, java.lang.Iterable<? extends T4> fourth) zip 4 Streams into 1
default <T2,T3,T4,R> Zippable<R>	zip4(java.lang.Iterable<? extends T2> second, java.lang.Iterable<? extends T3> third, java.lang.Iterable<? extends T4> fourth, Fn4<? super T,? super T2,? super T3,? super T4,? extends R> fn)
default <T2,R> Zippable<R>	zipP(org.reactivestreams.Publisher<? extends T2> publisher, java.util.function.BiFunction<? super T,? super T2,? extends R> fn) Zip (combine) this Zippable with the supplied Publisher, using the supplied combining function
default <U> Zippable<org.jooq.lambda.tuple.Tuple2<T,U>>	zipP(org.reactivestreams.Publisher<? extends U> other)
default <U> Zippable<org.jooq.lambda.tuple.Tuple2<T,U>>	zipS(java.util.stream.Stream<? extends U> other) Zip (combine) this Zippable with the supplied Stream combining both into a Tuple2
default <U,R> Zippable<R>	zipS(java.util.stream.Stream<? extends U> other, java.util.function.BiFunction<? super T,? super U,? extends R> zipper) Zip (combine) this Zippable with the supplied Stream, using the supplied combining function
default <R> Zippable<R>	zipWith(java.lang.Iterable<java.util.function.Function<? super T,? extends R>> fn)
default <R> Zippable<R>	zipWithP(org.reactivestreams.Publisher<java.util.function.Function<? super T,? extends R>> fn)
default <R> Zippable<R>	zipWithS(java.util.stream.Stream<java.util.function.Function<? super T,? extends R>> fn)

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.aol.cyclops2.types.functor.Transformable

cast, map, peek, retry, retry, trampoline

Method Detail

zip

default Zippable<T> zip(java.util.function.BinaryOperator<Zippable<T>> combiner,
                        Zippable<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 toNested handling Applicatives use the combineApplicatives operator in Semigroups {@see com.aol.cyclops2.Semigroups#combineApplicatives(BiFunction) } or Monoids { {@see com.aol.cyclops2.Monoids#combineApplicatives(java.util.function.Function, com.aol.cyclops2.function.Monoid) }

 {@code


  BinaryOperator> sumMaybes = Semigroups.combineScalarFunctors(Semigroups.intSum);
        Maybe.just(1).zip(sumMaybes, Maybe.just(5))
       //Maybe.just(6));
 }
 

zipWith

default <R> Zippable<R> zipWith(java.lang.Iterable<java.util.function.Function<? super T,? extends R>> fn)

zipWithS

default <R> Zippable<R> zipWithS(java.util.stream.Stream<java.util.function.Function<? super T,? extends R>> fn)

zipWithP

default <R> Zippable<R> zipWithP(org.reactivestreams.Publisher<java.util.function.Function<? super T,? extends R>> fn)

zip

default <T2,R> Zippable<R> zip(java.lang.Iterable<? extends T2> iterable,
                               java.util.function.BiFunction<? super T,? super T2,? extends R> fn)

Zip (combine) this Zippable with the supplied Iterable using the supplied combining function

Parameters:

iterable - toNested zip with

fn - Zip function

Returns:

Combined zippable

zipP

default <T2,R> Zippable<R> zipP(org.reactivestreams.Publisher<? extends T2> publisher,
                                java.util.function.BiFunction<? super T,? super T2,? extends R> fn)

Zip (combine) this Zippable with the supplied Publisher, using the supplied combining function

Parameters:

publisher - toNested combine with

fn - Zip / combining function

Returns:

Combined zippable

zipS

default <U,R> Zippable<R> zipS(java.util.stream.Stream<? extends U> other,
                               java.util.function.BiFunction<? super T,? super U,? extends R> zipper)

Zip (combine) this Zippable with the supplied Stream, using the supplied combining function

Parameters:

other - Stream toNested combine with

zipper - Zip / combining function

Returns:

Combined zippable

zipS

default <U> Zippable<org.jooq.lambda.tuple.Tuple2<T,U>> zipS(java.util.stream.Stream<? extends U> other)

Zip (combine) this Zippable with the supplied Stream combining both into a Tuple2

Parameters:

other - Stream toNested combine with

Returns:

Combined Zippable

zipP

default <U> Zippable<org.jooq.lambda.tuple.Tuple2<T,U>> zipP(org.reactivestreams.Publisher<? extends U> other)

zip

default <U> Zippable<org.jooq.lambda.tuple.Tuple2<T,U>> zip(java.lang.Iterable<? extends U> other)

Zip (combine) this Zippable with the supplied Iterable combining both into a Tuple2

Parameters:

other - Iterable toNested combine with

Returns:

zip3

default <S,U> Zippable<org.jooq.lambda.tuple.Tuple3<T,S,U>> zip3(java.lang.Iterable<? extends S> second,
                                                                 java.lang.Iterable<? extends U> third)

zip 3 Streams into one

 
  List<Tuple3<Integer, Integer, Character>> list = of(1, 2, 3, 4, 5, 6).zip3(of(100, 200, 300, 400), of('a', 'b', 'c')).collect(CyclopsCollectors.toList());

  // [[1,100,'a'],[2,200,'b'],[3,300,'c']]
 

 

zip3

default <S,U,R> Zippable<R> zip3(java.lang.Iterable<? extends S> second,
                                 java.lang.Iterable<? extends U> third,
                                 Fn3<? super T,? super S,? super U,? extends R> fn3)

zip4

default <T2,T3,T4> Zippable<org.jooq.lambda.tuple.Tuple4<T,T2,T3,T4>> zip4(java.lang.Iterable<? extends T2> second,
                                                                           java.lang.Iterable<? extends T3> third,
                                                                           java.lang.Iterable<? extends T4> fourth)

zip 4 Streams into 1

 
  List<Tuple4<Integer, Integer, Character, String>> list = of(1, 2, 3, 4, 5, 6).zip4(of(100, 200, 300, 400), of('a', 'b', 'c'), of("hello", "world"))
          .collect(CyclopsCollectors.toList());

 
 // [[1,100,'a',"hello"],[2,200,'b',"world"]]
 

zip4

default <T2,T3,T4,R> Zippable<R> zip4(java.lang.Iterable<? extends T2> second,
                                      java.lang.Iterable<? extends T3> third,
                                      java.lang.Iterable<? extends T4> fourth,
                                      Fn4<? super T,? super T2,? super T3,? super T4,? extends R> fn)