Xor.Primary (cyclops-react 1.0.5 API)

java.lang.Object
- com.aol.cyclops.control.Xor.Primary<ST,PT>

All Implemented Interfaces:

Xor<ST,PT>, ApplicativeFunctor<PT>, BiFunctor<ST,PT>, Combiner<PT>, Convertable<PT>, ConvertableFunctor<PT>, Filterable<PT>, Foldable<PT>, Functor<PT>, MonadicValue<PT>, To<Xor<ST,PT>>, Unit<PT>, Value<PT>, Visitable<PT>, Zippable<PT>, java.lang.Iterable<PT>, java.util.function.Predicate<PT>, java.util.function.Supplier<PT>, org.reactivestreams.Publisher<PT>

Enclosing interface:

Xor<ST,PT>
```
public static class Xor.Primary<ST,PT>
extends java.lang.Object
implements Xor<ST,PT>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.aol.cyclops.control.Xor
  Xor.Primary<ST,PT>, Xor.Secondary<ST,PT>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.applicative.ApplicativeFunctor
  ApplicativeFunctor.Applicatives, ApplicativeFunctor.ApplyFunctions<T>
- 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>

Constructor Summary

Constructors
Constructor and Description

Primary()

Constructors
Constructor and Description
`Primary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T2,R> Xor<ST,R>`	`combine(Value<? extends T2> app, java.util.function.BiFunction<? super PT,? super T2,? extends R> fn)` Lazily combine this ApplicativeFunctor with the supplied value via the supplied BiFunction Example
`boolean`	`equals(java.lang.Object obj)`
`Xor<ST,PT>`	`filter(java.util.function.Predicate<? super PT> test)` Keep only elements for which the supplied predicates hold e.g.
`<RT1> Xor<ST,RT1>`	`flatMap(java.util.function.Function<? super PT,? extends MonadicValue<? extends RT1>> mapper)` A flattening transformation operation (@see `Optional.flatMap(Function)`
`PT`	`get()`
`int`	`hashCode()`
`boolean`	`isPrimary()`
`boolean`	`isSecondary()`
`<R> Xor<ST,R>`	`map(java.util.function.Function<? super PT,? extends R> fn)` Transform this functor using the supplied transformation function
`<R> Eval<R>`	`matches(java.util.function.Function<Matchable.CheckValue1<ST,R>,Matchable.CheckValue1<ST,R>> secondary, java.util.function.Function<Matchable.CheckValue1<PT,R>,Matchable.CheckValue1<PT,R>> primary, java.util.function.Supplier<? extends R> otherwise)` Pattern match on the value/s inside this Xor.
`java.lang.String`	`mkString()` Returns the class name and the name of the subclass, if there is any value, the value is showed between square brackets.
`Xor<ST,PT>`	`peek(java.util.function.Consumer<? super PT> action)` Peek at the current value of this Functor, without transforming it
`void`	`peek(java.util.function.Consumer<? super ST> stAction, java.util.function.Consumer<? super PT> ptAction)`
`<LT1> Xor<LT1,PT>`	`secondaryFlatMap(java.util.function.Function<? super ST,? extends Xor<LT1,PT>> mapper)` Perform a flatMap operation on the Secondary type
`ST`	`secondaryGet()`
`<R> Xor<R,PT>`	`secondaryMap(java.util.function.Function<? super ST,? extends R> fn)` Always map the Secondary type of this Xor if it is present using the provided transformation function
`Xor<ST,PT>`	`secondaryPeek(java.util.function.Consumer<? super ST> action)` Peek at the Secondary type value if present
`java.util.Optional<ST>`	`secondaryToOptional()`
`Xor<ST,PT>`	`secondaryToPrimayFlatMap(java.util.function.Function<? super ST,? extends Xor<ST,PT>> fn)` A flatMap operation that keeps the Secondary and Primary types the same
`Xor<ST,PT>`	`secondaryToPrimayMap(java.util.function.Function<? super ST,? extends PT> fn)` If this Xor contains the Secondary type, map it's value so that it contains the Primary type
`ReactiveSeq<ST>`	`secondaryToStream()`
`Value<ST>`	`secondaryValue()`
`Xor<PT,ST>`	`swap()` Swap types so operations directly affect the current (pre-swap) Secondary type
`Ior<ST,PT>`	`toIor()` Return an Ior that can be this object or a Ior.primary or Ior.secondary
`java.lang.String`	`toString()`
`<R> R`	`visit(java.util.function.Function<? super ST,? extends R> secondary, java.util.function.Function<? super PT,? extends R> primary)` Visitor pattern for this Ior.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.aol.cyclops.control.Xor
accumulatePrimary, accumulatePrimary, accumulatePrimary, accumulateSecondary, accumulateSecondary, accumulateSecondary, anyM, applyAny, bicast, bimap, bipeek, bitrampoline, cast, coflatMap, combine, combine, combineEager, combineToList, consumeAny, filterNot, flatMapIterable, flatMapPublisher, forEach2, forEach2, forEach3, forEach3, forEach4, forEach4, fromIterable, fromPublisher, isPresent, list, mapBoth, nest, notNull, ofType, patternMatch, primary, secondary, sequencePrimary, sequenceSecondary, toOptional, toXor, toXor, trampoline, unit, visitAny, visitAny, 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.applicative.ApplicativeFunctor
applyFunctions

Methods inherited from interface com.aol.cyclops.types.Value
collect, fold, fold, generate, iterate, iterator, mapReduce, newSubscriber, of, stream, subscribe, test, toDequeX, toEvalAlways, toEvalLater, toEvalNow, toFeatureToggle, toFutureStream, toFutureStream, toLazyImmutable, toList, toListX, toMaybe, toMutable, toPBagX, toPOrderedSetX, toPQueueX, toPSetX, toPStackX, toPVectorX, toQueueX, toSetX, toSimpleReact, toSimpleReact, toSortedSetX, toTry, toTry, toTry, 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, orElse, orElseGet, orElseThrow, toAtomicReference, toCompletableFuture, toCompletableFutureAsync, toCompletableFutureAsync, toFutureW, toFutureWAsync, toFutureWAsync, toOptionalAtomicReference, toStream, visit

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

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

- Constructor Detail
  - Primary
```
public Primary()
```
- Method Detail
  - secondaryToPrimayMap
```
public Xor<ST,PT> secondaryToPrimayMap(java.util.function.Function<? super ST,? extends PT> fn)
```
    Description copied from interface: Xor
    
    If this Xor contains the Secondary type, map it's value so that it contains the Primary type
    
    Specified by:
    
    secondaryToPrimayMap in interface Xor<ST,PT>
    
    Parameters:
    
    fn - Function to map secondary type to primary
    
    Returns:
    
    Xor with secondary type mapped to primary
  - secondaryMap
```
public <R> Xor<R,PT> secondaryMap(java.util.function.Function<? super ST,? extends R> fn)
```
    Description copied from interface: Xor
    
    Always map the Secondary type of this Xor if it is present using the provided transformation function
    
    Specified by:
    
    secondaryMap in interface Xor<ST,PT>
    
    Parameters:
    
    fn - Transformation function for Secondary types
    
    Returns:
    
    Xor with Secondary type transformed
  - map
```
public <R> Xor<ST,R> map(java.util.function.Function<? super PT,? extends R> fn)
```
    Description copied from interface: Functor
    Transform this functor using the supplied transformation function
```
  
  
  
    of(1,2,3).map(i->i*2)
    
    //[2,4,6]
  
 
 
```
    Specified by:
    
    map in interface Xor<ST,PT>
    
    Specified by:
    
    map in interface ConvertableFunctor<PT>
    
    Specified by:
    
    map in interface Functor<PT>
    
    Specified by:
    
    map in interface MonadicValue<PT>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Transformed Functor
  - secondaryPeek
```
public Xor<ST,PT> secondaryPeek(java.util.function.Consumer<? super ST> action)
```
    Description copied from interface: Xor
    
    Peek at the Secondary type value if present
    
    Specified by:
    
    secondaryPeek in interface Xor<ST,PT>
    
    Parameters:
    
    action - Consumer to peek at the Secondary type value
    
    Returns:
    
    Xor with the same values as before
  - peek
```
public Xor<ST,PT> peek(java.util.function.Consumer<? super PT> action)
```
    Description copied from interface: Functor
    Peek at the current value of this Functor, without transforming it
```
  
  
  
    of(1,2,3).map(System.out::println)
    
    1
    2
    3
  
 
 
```
    Specified by:
    
    peek in interface Xor<ST,PT>
    
    Specified by:
    
    peek in interface Functor<PT>
    
    Parameters:
    
    action - Consumer that recieves each element from this Functor
    
    Returns:
    
    Functor that will peek at each value
  - filter
```
public Xor<ST,PT> filter(java.util.function.Predicate<? super PT> test)
```
    Description copied from interface: Filterable
    Keep only elements for which the supplied predicates hold e.g.
```
  
   
     of(1,2,3).filter(i->i>2);
     
     //[3]
   
 
 
```
    Specified by:
    
    filter in interface Xor<ST,PT>
    
    Specified by:
    
    filter in interface Filterable<PT>
    
    Specified by:
    
    filter in interface MonadicValue<PT>
    
    Parameters:
    
    test - to filter elements by, retaining matches
    
    Returns:
    
    Filterable with elements removed where the predicate does not hold
  - swap
```
public Xor<PT,ST> swap()
```
    Description copied from interface: Xor
    Swap types so operations directly affect the current (pre-swap) Secondary type
```
   
    
    Xor.secondary("hello")
       .map(v->v+" world") 
    //Xor.seconary["hello"]
    
    Xor.secondary("hello")
       .swap()
       .map(v->v+" world") 
       .swap()
    //Xor.seconary["hello world"]
  
  
```
    Specified by:
    
    swap in interface Xor<ST,PT>
    
    Returns:
    
    Swap the primary and secondary types, allowing operations directly on what was the Secondary type
  - get
```
public PT get()
```
    Specified by:
    
    get in interface Xor<ST,PT>
    
    Specified by:
    
    get in interface Convertable<PT>
    
    Specified by:
    
    get in interface java.util.function.Supplier<PT>
    
    Returns:
    
    Contained value, maybe null
  - secondaryGet
```
public ST secondaryGet()
```
    Specified by:
    
    secondaryGet in interface Xor<ST,PT>
    
    Returns:
    
    The Secondary Value if present, otherwise null
  - secondaryToOptional
```
public java.util.Optional<ST> secondaryToOptional()
```
    Specified by:
    
    secondaryToOptional in interface Xor<ST,PT>
    
    Returns:
    
    The Secondary value wrapped in an Optional if present, otherwise an empty Optional
  - secondaryToStream
```
public ReactiveSeq<ST> secondaryToStream()
```
    Specified by:
    
    secondaryToStream in interface Xor<ST,PT>
    
    Returns:
    
    A Stream containing the secondary value if present, otherwise an empty Stream
  - flatMap
```
public <RT1> Xor<ST,RT1> flatMap(java.util.function.Function<? super PT,? extends MonadicValue<? extends RT1>> mapper)
```
    Description copied from interface: MonadicValue
    A flattening transformation operation (@see Optional.flatMap(Function)
```
  
   Eval.now(1).map(i->i+2).flatMap(i->Eval.later(()->i*3);
   //Eval[9]
 
 
```
    Specified by:
    
    flatMap in interface Xor<ST,PT>
    
    Specified by:
    
    flatMap in interface MonadicValue<PT>
    
    Parameters:
    
    mapper - transformation function
    
    Returns:
    
    MonadicValue
  - secondaryFlatMap
```
public <LT1> Xor<LT1,PT> secondaryFlatMap(java.util.function.Function<? super ST,? extends Xor<LT1,PT>> mapper)
```
    Description copied from interface: Xor
    
    Perform a flatMap operation on the Secondary type
    
    Specified by:
    
    secondaryFlatMap in interface Xor<ST,PT>
    
    Parameters:
    
    mapper - Flattening transformation function
    
    Returns:
    
    Xor containing the value inside the result of the transformation function as the Secondary value, if the Secondary type was present
  - secondaryToPrimayFlatMap
```
public Xor<ST,PT> secondaryToPrimayFlatMap(java.util.function.Function<? super ST,? extends Xor<ST,PT>> fn)
```
    Description copied from interface: Xor
    
    A flatMap operation that keeps the Secondary and Primary types the same
    
    Specified by:
    
    secondaryToPrimayFlatMap in interface Xor<ST,PT>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Xor
  - peek
```
public void peek(java.util.function.Consumer<? super ST> stAction,
                 java.util.function.Consumer<? super PT> ptAction)
```
    Specified by:
    
    peek in interface Xor<ST,PT>
  - isPrimary
```
public boolean isPrimary()
```
    Specified by:
    
    isPrimary in interface Xor<ST,PT>
    
    Returns:
    
    True if this is a primary Xor
  - isSecondary
```
public boolean isSecondary()
```
    Specified by:
    
    isSecondary in interface Xor<ST,PT>
    
    Returns:
    
    True if this is a secondary Xor
  - secondaryValue
```
public Value<ST> secondaryValue()
```
    Specified by:
    
    secondaryValue in interface Xor<ST,PT>
    
    Returns:
    
    A Value containing the secondary Value if present
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - mkString
```
public java.lang.String mkString()
```
    Description copied from interface: Value
    
    Returns the class name and the name of the subclass, if there is any value, the value is showed between square brackets.
    
    Specified by:
    
    mkString in interface Value<PT>
    
    Returns:
    
    String
  - toIor
```
public Ior<ST,PT> toIor()
```
    Description copied from interface: Value
    
    Return an Ior that can be this object or a Ior.primary or Ior.secondary
    
    Specified by:
    
    toIor in interface Xor<ST,PT>
    
    Specified by:
    
    toIor in interface Value<PT>
    
    Returns:
    
    new Ior
  - visit
```
public <R> R visit(java.util.function.Function<? super ST,? extends R> secondary,
                   java.util.function.Function<? super PT,? extends R> primary)
```
    Description copied from interface: Xor
    Visitor pattern for this Ior. Execute the secondary function if this Xor contains an element of the secondary type Execute the primary function if this Xor contains an element of the primary type
```
  
  Xor.primary(10)
     .visit(secondary->"no", primary->"yes")
  //Xor["yes"]
        
        Xor.secondary(90)
           .visit(secondary->"no", primary->"yes")
        //Xor["no"]
         
 
 
 
 
```
    Specified by:
    
    visit in interface Xor<ST,PT>
    
    Parameters:
    
    secondary - Function to execute if this is a Secondary Xor
    
    primary - Function to execute if this is a Primary Ior
    
    Returns:
    
    Result of executing the appropriate function
  - matches
```
public <R> Eval<R> matches(java.util.function.Function<Matchable.CheckValue1<ST,R>,Matchable.CheckValue1<ST,R>> secondary,
                           java.util.function.Function<Matchable.CheckValue1<PT,R>,Matchable.CheckValue1<PT,R>> primary,
                           java.util.function.Supplier<? extends R> otherwise)
```
    Description copied from interface: Xor
    Pattern match on the value/s inside this Xor.
```
  
 
 import static com.aol.cyclops.control.Matchable.otherwise;
       import static com.aol.cyclops.control.Matchable.then;
       import static com.aol.cyclops.control.Matchable.when;
       import static com.aol.cyclops.util.function.Predicates.instanceOf;
 
 Xor.primary(10)
    .matches(c->c.is(when("10"),then("hello")),
                   c->c.is(when(instanceOf(Integer.class)), then("error")),
                   otherwise("miss"))
           .get()
       //"error" Note the second case, 'primary' case is the one that matches
 
 
 
 
```
    Specified by:
    
    matches in interface Xor<ST,PT>
    
    Parameters:
    
    secondary - Pattern matching function executed if this Xor has the secondary type
    
    primary - Pattern matching function executed if this Xor has the primary type
    
    otherwise - Supplier used to provide a value if the selecting pattern matching function fails to find a match
    
    Returns:
    
    Lazy result of the pattern matching
  - combine
```
public <T2,R> Xor<ST,R> combine(Value<? extends T2> app,
                                java.util.function.BiFunction<? super PT,? super T2,? extends R> fn)
```
    Description copied from interface: Combiner
    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
   
 
 
```
    Specified by:
    
    combine in interface Xor<ST,PT>
    
    Specified by:
    
    combine in interface Combiner<PT>
    
    Parameters:
    
    app - Value to combine with this one.
    
    fn - BiFunction to combine them
    
    Returns:
    
    New Applicativefunctor that represents the combined values
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Xor.Primary<ST,PT>

Nested Class Summary

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

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

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.types.Convertable

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface java.lang.Iterable

Constructor Detail

Primary

Method Detail

secondaryToPrimayMap

secondaryMap

map

secondaryPeek

peek

filter

swap

get

secondaryGet

secondaryToOptional

secondaryToStream

flatMap

secondaryFlatMap

secondaryToPrimayFlatMap

peek

isPrimary

isSecondary

secondaryValue

toString

mkString

toIor

visit

matches

combine

equals

hashCode