Xor (simple-react 1.0.0-RC2.1 API)

Type Parameters:: ST - Secondary type; PT - Primary type

All Superinterfaces:: Applicativable<PT>, Convertable<PT>, ConvertableFunctor<PT>, Filterable<PT>, Foldable<PT>, Functor<PT>, java.lang.Iterable<PT>, Matchable<PT>, java.util.function.Predicate<PT>, org.reactivestreams.Publisher<PT>, java.util.function.Supplier<PT>, Unit<PT>, Value<PT>

All Known Implementing Classes:: Xor.Primary, Xor.Secondary

public interface Xor<ST,PT>
extends java.util.function.Supplier<PT>, Value<PT>, Functor<PT>, Filterable<PT>, Applicativable<PT>

eXclusive Or (Xor) 'Right' (or primary type) biased disjunct union. No 'projections' are provided, swap() and secondaryXXXX alternative methods can be used instead.

   
      Xor.primary("hello").map(v->v+" world") 
      //Xor.primary["hello world"]

Values can be accumulated via

   
  Xor.accumulateSecondary(ListX.of(Xor.secondary("failed1"),
                                                    Xor.secondary("failed2"),
                                                    Xor.primary("success")),
                                                    Semigroups.stringConcat)
  
  //failed1failed2
  
   Xor<String,String> fail1 = Xor.secondary("failed1");
     fail1.swap().ap((a,b)->a+b)
                 .ap(Xor.secondary("failed2").swap())
                 .ap(Xor.<String,String>primary("success").swap())
  
  //failed1failed2

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Xor.Primary<ST,PT>

static class Xor.Secondary<ST,PT>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.applicative.Applicativable
  Applicativable.Applicatives, Applicativable.SemigroupApplyer<T>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.Value
  Value.ValueImpl<T>
- Nested classes/interfaces inherited from interface com.aol.cyclops.control.Matchable
  Matchable.AsMatchable, Matchable.AutoCloseableMatchableIterable<TYPE>, Matchable.CheckValue1<T,R>, Matchable.CheckValue2<T1,T2,R>, Matchable.CheckValue3<T1,T2,T3,R>, Matchable.CheckValue4<T1,T2,T3,T4,R>, Matchable.CheckValue5<T1,T2,T3,T4,T5,R>, Matchable.CheckValueOpt<T,R>, Matchable.CheckValues<T,R>, Matchable.MatchableIterable<TYPE>, Matchable.MatchableObject<TYPE>, Matchable.MatchableOptional<T>, Matchable.MatchSelf<TYPE>, Matchable.MTuple1<T1>, Matchable.MTuple2<T1,T2>, Matchable.MTuple3<T1,T2,T3>, Matchable.MTuple4<T1,T2,T3,T4>, Matchable.MTuple5<T1,T2,T3,T4,T5>, Matchable.MXor<T1,T2>, Matchable.ValueAndOptionalMatcher<T>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.Convertable
  Convertable.SupplierToConvertable<T>

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Xor.Primary<ST,PT>`
`static class`	`Xor.Secondary<ST,PT>`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static <ST,PT,R> Xor<?,R>`	`accumulatePrimary(CollectionX<Xor<ST,PT>> xors, java.util.function.Function<? super PT,R> mapper, Semigroup<R> reducer)`
`static <ST,PT,R> Xor<?,R>`	`accumulatePrimary(CollectionX<Xor<ST,PT>> xors, Reducer<R> reducer)`
`static <ST,PT> Xor<?,PT>`	`accumulatePrimary(CollectionX<Xor<ST,PT>> xors, Semigroup<PT> reducer)`
`static <ST,PT,R> Xor<?,R>`	`accumulateSecondary(CollectionX<Xor<ST,PT>> xors, java.util.function.Function<? super ST,R> mapper, Semigroup<R> reducer)`
`static <ST,PT,R> Xor<?,R>`	`accumulateSecondary(CollectionX<Xor<ST,PT>> xors, Reducer<R> reducer)`
`static <ST,PT> Xor<?,ST>`	`accumulateSecondary(CollectionX<Xor<ST,PT>> xors, Semigroup<ST> reducer)` `Xor.accumulateSecondary(ListX.of(Xor.secondary("failed1"), Xor.secondary("failed2"), Xor.primary("success")), Semigroups.stringConcat) //Xors.Primary[failed1failed2]`
`default AnyMValue<PT>`	`anyM()`
`default <U> Xor<ST,U>`	`cast(java.lang.Class<U> type)` Cast all elements in a stream to a given type, possibly throwing a `ClassCastException`.
`Xor<ST,PT>`	`filter(java.util.function.Predicate<? super PT> test)`
`default Xor<ST,PT>`	`filterNot(java.util.function.Predicate<? super PT> fn)`
`<LT1,RT1> Xor<LT1,RT1>`	`flatMap(java.util.function.Function<? super PT,? extends Xor<LT1,RT1>> mapper)`
`PT`	`get()`
`boolean`	`isPrimary()`
`boolean`	`isSecondary()`
`<R> Xor<ST,R>`	`map(java.util.function.Function<? super PT,? extends R> fn)`
`<R> Eval<R>`	`matches(java.util.function.Function<Matchable.CheckValue1<ST,R>,Matchable.CheckValue1<ST,R>> fn1, java.util.function.Function<Matchable.CheckValue1<PT,R>,Matchable.CheckValue1<PT,R>> fn2, java.util.function.Supplier<? extends R> otherwise)`
`default Xor<ST,PT>`	`notNull()`
`default <U> Xor<ST,U>`	`ofType(java.lang.Class<U> type)` Keep only those elements in a stream that are of a given type.
`default <R> Xor<ST,R>`	`patternMatch(java.util.function.Function<Matchable.CheckValues<PT,R>,Matchable.CheckValues<PT,R>> case1, java.util.function.Supplier<? extends R> otherwise)` Transform the elements of this Stream with a Pattern Matching case and default value
`Xor<ST,PT>`	`peek(java.util.function.Consumer<? super PT> action)`
`void`	`peek(java.util.function.Consumer<? super ST> stAction, java.util.function.Consumer<? super PT> ptAction)`
`static <ST,PT> Xor<ST,PT>`	`primary(PT value)`
`static <ST,PT> Xor<ST,PT>`	`secondary(ST value)` Create an instance of the secondary type.
`<LT1,RT1> Xor<LT1,RT1>`	`secondaryFlatMap(java.util.function.Function<? super ST,? extends Xor<LT1,RT1>> mapper)`
`ST`	`secondaryGet()`
`<R> Xor<R,PT>`	`secondaryMap(java.util.function.Function<? super ST,? extends R> fn)`
`Xor<ST,PT>`	`secondaryPeek(java.util.function.Consumer<? super ST> action)`
`java.util.Optional<ST>`	`secondaryToOptional()`
`Xor<ST,PT>`	`secondaryToPrimayFlatMap(java.util.function.Function<? super ST,? extends Xor<ST,PT>> fn)`
`Xor<ST,PT>`	`secondaryToPrimayMap(java.util.function.Function<? super ST,? extends PT> fn)`
`ReactiveSeq<ST>`	`secondaryToStream()`
`Value<ST>`	`secondaryValue()`
`static <ST,PT> Xor<ListX<ST>,ListX<PT>>`	`sequencePrimary(CollectionX<Xor<ST,PT>> xors)`
`static <ST,PT> Xor<ListX<PT>,ListX<ST>>`	`sequenceSecondary(CollectionX<Xor<ST,PT>> xors)`
`Xor<PT,ST>`	`swap()`
`Ior<ST,PT>`	`toIor()`
`default Xor<ST,PT>`	`toXor()`
`default <R> Xor<ST,R>`	`trampoline(java.util.function.Function<? super PT,? extends Trampoline<? extends R>> mapper)` Performs a map operation that can call a recursive method without running out of stack space
`default <T> Xor<?,T>`	`unit(T unit)`
`default <R> R`	`visit(java.util.function.Function<? super ST,? extends R> secondary, java.util.function.Function<? super PT,? extends R> primary)`
`default <R1,R2> Xor<R1,R2>`	`visitXor(java.util.function.Function<? super ST,? extends R1> secondary, java.util.function.Function<? super PT,? extends R2> primary)`

Methods inherited from interface com.aol.cyclops.types.applicative.Applicativable
ap, ap, ap1, ap2, ap3, ap4, ap5

Methods inherited from interface com.aol.cyclops.types.Value
convertTo, convertToAsync, fold, fold, generate, getMatchable, iterate, mkString, newSubscriber, toDequeX, toEvalAlways, toEvalLater, toEvalNow, toFutureStream, toFutureStream, toLazyImmutable, toListX, toMaybe, toMutable, toPBagX, toPOrderedSetX, toPQueueX, toPSetX, toPStackX, toPVectorX, toQueueX, toSetX, toSimpleReact, toSimpleReact, toSortedSetX, toTry, toTry, unapply

Methods inherited from interface com.aol.cyclops.types.Foldable
foldRight, foldRight, foldRight, foldRightMapToType, join, join, join, mapReduce, print, print, printErr, printOut, reduce, reduce, reduce, reduce, reduce, reduce, reduce

Methods inherited from interface com.aol.cyclops.control.Matchable
from, from, from, from, from, from, from, from, from, from, fromCharSequence, fromIterable, fromOptional, listOfValues, ofDecomposable, otherwise, otherwise, then, then, when, when, when, when, when, when, when, when, when, when, whenGuard, whenTrue, whenValues

Methods inherited from interface com.aol.cyclops.types.Convertable
fromSupplier, orElse, orElseGet, orElseThrow, toAtomicReference, toCompletableFuture, toCompletableFutureAsync, toCompletableFutureAsync, toFutureW, toList, toOptional, toOptionalAtomicReference, toStream, visit

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface java.util.function.Predicate
and, isEqual, negate, or

Method Detail

secondary
```
static <ST,PT> Xor<ST,PT> secondary(ST value)
```
Create an instance of the secondary type. Most methods are biased to the primary type, so you will need to use swap() or secondaryXXXX to manipulate the wrapped value
```
  
   Xor.<Integer,Integer>secondary(10).map(i->i+1);
   //Xor.secondary[10]
    
    Xor.<Integer,Integer>secondary(10).swap().map(i->i+1);
    //Xor.primary[11]
 
 
```
Parameters:

value - to wrap

Returns:

Secondary instance of Xor

primary

static <ST,PT> Xor<ST,PT> primary(PT value)

anyM
```
default AnyMValue<PT> anyM()
```

unit
```
default <T> Xor<?,T> unit(T unit)
```
Specified by:

unit in interface Unit<PT>

filter

Xor<ST,PT> filter(java.util.function.Predicate<? super PT> test)

Specified by:: filter in interface Filterable<PT>

secondaryToPrimayMap

Xor<ST,PT> secondaryToPrimayMap(java.util.function.Function<? super ST,? extends PT> fn)

secondaryMap

<R> Xor<R,PT> secondaryMap(java.util.function.Function<? super ST,? extends R> fn)

map
```
<R> Xor<ST,R> map(java.util.function.Function<? super PT,? extends R> fn)
```
Specified by:

map in interface ConvertableFunctor<PT>

Specified by:

map in interface Functor<PT>

secondaryPeek

Xor<ST,PT> secondaryPeek(java.util.function.Consumer<? super ST> action)

peek

Xor<ST,PT> peek(java.util.function.Consumer<? super PT> action)

Specified by:: peek in interface Functor<PT>

swap
```
Xor<PT,ST> swap()
```

toIor
```
Ior<ST,PT> toIor()
```
Specified by:

toIor in interface Value<PT>

toXor
```
default Xor<ST,PT> toXor()
```
Specified by:

toXor in interface Value<PT>

sequenceSecondary

static <ST,PT> Xor<ListX<PT>,ListX<ST>> sequenceSecondary(CollectionX<Xor<ST,PT>> xors)

accumulateSecondary

static <ST,PT,R> Xor<?,R> accumulateSecondary(CollectionX<Xor<ST,PT>> xors,
                                              Reducer<R> reducer)

accumulateSecondary

static <ST,PT,R> Xor<?,R> accumulateSecondary(CollectionX<Xor<ST,PT>> xors,
                                              java.util.function.Function<? super ST,R> mapper,
                                              Semigroup<R> reducer)

sequencePrimary

static <ST,PT> Xor<ListX<ST>,ListX<PT>> sequencePrimary(CollectionX<Xor<ST,PT>> xors)

accumulatePrimary

static <ST,PT,R> Xor<?,R> accumulatePrimary(CollectionX<Xor<ST,PT>> xors,
                                            Reducer<R> reducer)

accumulatePrimary

static <ST,PT,R> Xor<?,R> accumulatePrimary(CollectionX<Xor<ST,PT>> xors,
                                            java.util.function.Function<? super PT,R> mapper,
                                            Semigroup<R> reducer)

accumulatePrimary

static <ST,PT> Xor<?,PT> accumulatePrimary(CollectionX<Xor<ST,PT>> xors,
                                           Semigroup<PT> reducer)

accumulateSecondary

static <ST,PT> Xor<?,ST> accumulateSecondary(CollectionX<Xor<ST,PT>> xors,
                                             Semigroup<ST> reducer)

  
 Xor.accumulateSecondary(ListX.of(Xor.secondary("failed1"),
													Xor.secondary("failed2"),
													Xor.primary("success")),
													Semigroups.stringConcat)
													
													
 //Xors.Primary[failed1failed2]

Parameters:: xors -; reducer -
Returns:

visit

default <R> R visit(java.util.function.Function<? super ST,? extends R> secondary,
                    java.util.function.Function<? super PT,? extends R> primary)

visitXor

default <R1,R2> Xor<R1,R2> visitXor(java.util.function.Function<? super ST,? extends R1> secondary,
                                    java.util.function.Function<? super PT,? extends R2> primary)

patternMatch

default <R> Xor<ST,R> patternMatch(java.util.function.Function<Matchable.CheckValues<PT,R>,Matchable.CheckValues<PT,R>> case1,
                                   java.util.function.Supplier<? extends R> otherwise)

Description copied from interface: Functor

Transform the elements of this Stream with a Pattern Matching case and default value

 
 List<String> result = CollectionX.of(1,2,3,4)
                                              .patternMatch(
                                                        c->c.valuesWhere(i->"even", (Integer i)->i%2==0 )
                                                      )
 
 // CollectionX["odd","even","odd","even"]

Specified by:: patternMatch in interface Functor<PT>
Parameters:: case1 - Function to generate a case (or chain of cases as a single case); otherwise - Value if supplied case doesn't match
Returns:: CollectionX where elements are transformed by pattern matching

matches

<R> Eval<R> matches(java.util.function.Function<Matchable.CheckValue1<ST,R>,Matchable.CheckValue1<ST,R>> fn1,
                    java.util.function.Function<Matchable.CheckValue1<PT,R>,Matchable.CheckValue1<PT,R>> fn2,
                    java.util.function.Supplier<? extends R> otherwise)

get
```
PT get()
```
Specified by:

get in interface Convertable<PT>

Specified by:

get in interface java.util.function.Supplier<PT>

Returns:

Contained value, maybe null

secondaryValue
```
Value<ST> secondaryValue()
```

secondaryGet
```
ST secondaryGet()
```

secondaryToOptional

java.util.Optional<ST> secondaryToOptional()

secondaryToStream
```
ReactiveSeq<ST> secondaryToStream()
```

flatMap

<LT1,RT1> Xor<LT1,RT1> flatMap(java.util.function.Function<? super PT,? extends Xor<LT1,RT1>> mapper)

secondaryFlatMap

<LT1,RT1> Xor<LT1,RT1> secondaryFlatMap(java.util.function.Function<? super ST,? extends Xor<LT1,RT1>> mapper)

secondaryToPrimayFlatMap

Xor<ST,PT> secondaryToPrimayFlatMap(java.util.function.Function<? super ST,? extends Xor<ST,PT>> fn)

peek

void peek(java.util.function.Consumer<? super ST> stAction,
          java.util.function.Consumer<? super PT> ptAction)

isPrimary
```
boolean isPrimary()
```

isSecondary
```
boolean isSecondary()
```

ofType
```
default <U> Xor<ST,U> ofType(java.lang.Class<U> type)
```
Description copied from interface: Filterable

Keep only those elements in a stream that are of a given type. // (1, 2, 3) ReactiveSeq.of(1, "a", 2, "b",3).ofType(Integer.class)

Specified by:

ofType in interface Filterable<PT>

filterNot

default Xor<ST,PT> filterNot(java.util.function.Predicate<? super PT> fn)

Specified by:: filterNot in interface Filterable<PT>

notNull
```
default Xor<ST,PT> notNull()
```
Specified by:

notNull in interface Filterable<PT>

cast
```
default <U> Xor<ST,U> cast(java.lang.Class<U> type)
```
Description copied from interface: Functor

Cast all elements in a stream to a given type, possibly throwing a ClassCastException. // ClassCastException ReactiveSeq.of(1, "a", 2, "b", 3).cast(Integer.class)

Specified by:

cast in interface Functor<PT>

trampoline

default <R> Xor<ST,R> trampoline(java.util.function.Function<? super PT,? extends Trampoline<? extends R>> mapper)

Description copied from interface: Functor

Performs a map operation that can call a recursive method without running out of stack space

 
 ReactiveSeq.of(10,20,30,40)
				 .trampoline(i-> fibonacci(i))
				 .forEach(System.out::println); 
				 
		Trampoline<Long> fibonacci(int i){
			return fibonacci(i,1,0);
		}
		Trampoline<Long> fibonacci(int n, long a, long b) {
	    	return n == 0 ? Trampoline.done(b) : Trampoline.more( ()->fibonacci(n-1, a+b, a));
		}		 
				 
 55
		6765
		832040
		102334155
 
 
 ReactiveSeq.of(10_000,200_000,3_000_000,40_000_000)
				 .trampoline(i-> fibonacci(i))
				 .forEach(System.out::println);
				 
				 
 completes successfully

Specified by:: trampoline in interface Functor<PT>
Returns:

Interface Xor<ST,PT>

Nested Class Summary

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

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

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

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

Method Summary

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

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

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

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

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

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.function.Predicate

Method Detail

secondary

primary

anyM

unit

filter

secondaryToPrimayMap

secondaryMap

map

secondaryPeek

peek

swap

toIor

toXor

sequenceSecondary

accumulateSecondary

accumulateSecondary

sequencePrimary

accumulatePrimary

accumulatePrimary

accumulatePrimary

accumulateSecondary

visit

visitXor

patternMatch

matches

get

secondaryValue

secondaryGet

secondaryToOptional

secondaryToStream

flatMap

secondaryFlatMap

secondaryToPrimayFlatMap

peek

isPrimary

isSecondary

ofType

filterNot

notNull

cast

trampoline