XorType.Box (cyclops-typeclasses 8.3.0 API)

java.lang.Object
- com.aol.cyclops.hkt.cyclops.XorType.Box<ST,PT>

All Implemented Interfaces:

com.aol.cyclops.control.Xor<ST,PT>, com.aol.cyclops.hkt.alias.Convert<com.aol.cyclops.hkt.alias.Higher2<XorType.µ,ST,PT>>, com.aol.cyclops.hkt.alias.Higher2<XorType.µ,ST,PT>, XorType<ST,PT>, com.aol.cyclops.types.applicative.ApplicativeFunctor<PT>, com.aol.cyclops.types.BiFunctor<ST,PT>, com.aol.cyclops.types.Combiner<PT>, com.aol.cyclops.types.Convertable<PT>, com.aol.cyclops.types.ConvertableFunctor<PT>, com.aol.cyclops.types.Filterable<PT>, com.aol.cyclops.types.Foldable<PT>, com.aol.cyclops.types.Functor<PT>, com.aol.cyclops.types.MonadicValue<PT>, com.aol.cyclops.types.MonadicValue2<ST,PT>, com.aol.cyclops.types.To<com.aol.cyclops.control.Xor<ST,PT>>, com.aol.cyclops.types.Unit<PT>, com.aol.cyclops.types.Value<PT>, com.aol.cyclops.types.Visitable<PT>, com.aol.cyclops.types.Zippable<PT>, java.lang.Iterable<PT>, java.util.function.Predicate<PT>, java.util.function.Supplier<PT>, org.derive4j.hkt.__<org.derive4j.hkt.__<XorType.µ,ST>,PT>, org.derive4j.hkt.__2<XorType.µ,ST,PT>, org.reactivestreams.Publisher<PT>

Enclosing interface:

XorType<ST,PT>
```
public static final class XorType.Box<ST,PT>
extends java.lang.Object
implements XorType<ST,PT>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.aol.cyclops.hkt.cyclops.XorType
  XorType.µ, XorType.Box<ST,PT>
- Nested classes/interfaces inherited from interface com.aol.cyclops.control.Xor
  com.aol.cyclops.control.Xor.Primary<ST,PT>, com.aol.cyclops.control.Xor.Secondary<ST,PT>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.applicative.ApplicativeFunctor
  com.aol.cyclops.types.applicative.ApplicativeFunctor.Applicatives, com.aol.cyclops.types.applicative.ApplicativeFunctor.ApplyFunctions<T>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.Value
  com.aol.cyclops.types.Value.ValueImpl<T>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.Convertable
  com.aol.cyclops.types.Convertable.SupplierToConvertable<T>

Constructor Summary

Constructors
Constructor and Description

Box()

Constructors
Constructor and Description
`Box()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T2,R> com.aol.cyclops.control.Xor<ST,R>`	`combine(com.aol.cyclops.types.Value<? extends T2> app, java.util.function.BiFunction<? super PT,? super T2,? extends R> fn)`
`boolean`	`equals(java.lang.Object obj)`
`com.aol.cyclops.control.Xor<ST,PT>`	`filter(java.util.function.Predicate<? super PT> test)`
`<LT1,RT1> com.aol.cyclops.control.Xor<LT1,RT1>`	`flatMap(java.util.function.Function<? super PT,? extends com.aol.cyclops.types.MonadicValue2<? extends LT1,? extends RT1>> mapper)`
`PT`	`get()`
`int`	`hashCode()`
`boolean`	`isPresent()`
`boolean`	`isPrimary()`
`boolean`	`isSecondary()`
`<R> com.aol.cyclops.control.Xor<ST,R>`	`map(java.util.function.Function<? super PT,? extends R> fn)`
`<R> com.aol.cyclops.control.Eval<R>`	`matches(java.util.function.Function<com.aol.cyclops.control.Matchable.CheckValue1<ST,R>,com.aol.cyclops.control.Matchable.CheckValue1<ST,R>> fn1, java.util.function.Function<com.aol.cyclops.control.Matchable.CheckValue1<PT,R>,com.aol.cyclops.control.Matchable.CheckValue1<PT,R>> fn2, java.util.function.Supplier<? extends R> otherwise)`
`com.aol.cyclops.control.Xor<ST,PT>`	`narrow()`
`com.aol.cyclops.control.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)`
`<LT1,RT1> com.aol.cyclops.control.Xor<LT1,RT1>`	`secondaryFlatMap(java.util.function.Function<? super ST,? extends com.aol.cyclops.control.Xor<LT1,RT1>> mapper)`
`ST`	`secondaryGet()`
`<R> com.aol.cyclops.control.Xor<R,PT>`	`secondaryMap(java.util.function.Function<? super ST,? extends R> fn)`
`com.aol.cyclops.control.Xor<ST,PT>`	`secondaryPeek(java.util.function.Consumer<? super ST> action)`
`java.util.Optional<ST>`	`secondaryToOptional()`
`com.aol.cyclops.control.Xor<ST,PT>`	`secondaryToPrimayFlatMap(java.util.function.Function<? super ST,? extends com.aol.cyclops.control.Xor<ST,PT>> fn)`
`com.aol.cyclops.control.Xor<ST,PT>`	`secondaryToPrimayMap(java.util.function.Function<? super ST,? extends PT> fn)`
`com.aol.cyclops.control.ReactiveSeq<ST>`	`secondaryToStream()`
`com.aol.cyclops.types.Value<ST>`	`secondaryValue()`
`com.aol.cyclops.control.Xor<PT,ST>`	`swap()`
`com.aol.cyclops.control.Ior<ST,PT>`	`toIor()`
`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)`

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

Methods inherited from interface com.aol.cyclops.hkt.cyclops.XorType
narrow, narrowK, primary, secondary, widen, widen2

Methods inherited from interface com.aol.cyclops.hkt.alias.Convert
convert

Methods inherited from interface com.aol.cyclops.control.Xor
accumulatePrimary, accumulatePrimary, accumulatePrimary, accumulateSecondary, accumulateSecondary, accumulateSecondary, anyM, bicast, bimap, bipeek, bitrampoline, cast, coflatMap, combine, combine, combineEager, combineToList, filterNot, flatMapIterable, flatMapPublisher, fromIterable, fromPublisher, list, mapBoth, nest, notNull, ofType, patternMatch, sequencePrimary, sequenceSecondary, toOptional, toXor, toXor, trampoline, unit, 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, mkString, 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
  - Box
```
public Box()
```
- Method Detail
  - secondaryMap
```
public <R> com.aol.cyclops.control.Xor<R,PT> secondaryMap(java.util.function.Function<? super ST,? extends R> fn)
```
    Specified by:
    
    secondaryMap in interface com.aol.cyclops.control.Xor<ST,PT>
  - visit
```
public <R> R visit(java.util.function.Function<? super ST,? extends R> secondary,
                   java.util.function.Function<? super PT,? extends R> primary)
```
    Specified by:
    
    visit in interface com.aol.cyclops.control.Xor<ST,PT>
  - narrow
```
public com.aol.cyclops.control.Xor<ST,PT> narrow()
```
    Returns:
    
    This back as a XorX
  - get
```
public PT get()
```
    Specified by:
    
    get in interface com.aol.cyclops.control.Xor<ST,PT>
    
    Specified by:
    
    get in interface com.aol.cyclops.types.Convertable<PT>
    
    Specified by:
    
    get in interface java.util.function.Supplier<PT>
  - isPresent
```
public boolean isPresent()
```
    Specified by:
    
    isPresent in interface com.aol.cyclops.control.Xor<ST,PT>
    
    Specified by:
    
    isPresent in interface com.aol.cyclops.types.Convertable<PT>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - 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
  - filter
```
public com.aol.cyclops.control.Xor<ST,PT> filter(java.util.function.Predicate<? super PT> test)
```
    Specified by:
    
    filter in interface com.aol.cyclops.control.Xor<ST,PT>
    
    Specified by:
    
    filter in interface com.aol.cyclops.types.Filterable<PT>
  - secondaryToPrimayMap
```
public com.aol.cyclops.control.Xor<ST,PT> secondaryToPrimayMap(java.util.function.Function<? super ST,? extends PT> fn)
```
    Specified by:
    
    secondaryToPrimayMap in interface com.aol.cyclops.control.Xor<ST,PT>
  - map
```
public <R> com.aol.cyclops.control.Xor<ST,R> map(java.util.function.Function<? super PT,? extends R> fn)
```
    Specified by:
    
    map in interface com.aol.cyclops.control.Xor<ST,PT>
    
    Specified by:
    
    map in interface com.aol.cyclops.types.ConvertableFunctor<PT>
    
    Specified by:
    
    map in interface com.aol.cyclops.types.Functor<PT>
    
    Specified by:
    
    map in interface com.aol.cyclops.types.MonadicValue<PT>
    
    Specified by:
    
    map in interface com.aol.cyclops.types.MonadicValue2<ST,PT>
  - secondaryPeek
```
public com.aol.cyclops.control.Xor<ST,PT> secondaryPeek(java.util.function.Consumer<? super ST> action)
```
    Specified by:
    
    secondaryPeek in interface com.aol.cyclops.control.Xor<ST,PT>
  - peek
```
public com.aol.cyclops.control.Xor<ST,PT> peek(java.util.function.Consumer<? super PT> action)
```
    Specified by:
    
    peek in interface com.aol.cyclops.control.Xor<ST,PT>
    
    Specified by:
    
    peek in interface com.aol.cyclops.types.Functor<PT>
  - swap
```
public com.aol.cyclops.control.Xor<PT,ST> swap()
```
    Specified by:
    
    swap in interface com.aol.cyclops.control.Xor<ST,PT>
  - toIor
```
public com.aol.cyclops.control.Ior<ST,PT> toIor()
```
    Specified by:
    
    toIor in interface com.aol.cyclops.control.Xor<ST,PT>
    
    Specified by:
    
    toIor in interface com.aol.cyclops.types.Value<PT>
  - matches
```
public <R> com.aol.cyclops.control.Eval<R> matches(java.util.function.Function<com.aol.cyclops.control.Matchable.CheckValue1<ST,R>,com.aol.cyclops.control.Matchable.CheckValue1<ST,R>> fn1,
                                                   java.util.function.Function<com.aol.cyclops.control.Matchable.CheckValue1<PT,R>,com.aol.cyclops.control.Matchable.CheckValue1<PT,R>> fn2,
                                                   java.util.function.Supplier<? extends R> otherwise)
```
    Specified by:
    
    matches in interface com.aol.cyclops.control.Xor<ST,PT>
  - secondaryValue
```
public com.aol.cyclops.types.Value<ST> secondaryValue()
```
    Specified by:
    
    secondaryValue in interface com.aol.cyclops.control.Xor<ST,PT>
  - secondaryGet
```
public ST secondaryGet()
```
    Specified by:
    
    secondaryGet in interface com.aol.cyclops.control.Xor<ST,PT>
  - secondaryToOptional
```
public java.util.Optional<ST> secondaryToOptional()
```
    Specified by:
    
    secondaryToOptional in interface com.aol.cyclops.control.Xor<ST,PT>
  - secondaryToStream
```
public com.aol.cyclops.control.ReactiveSeq<ST> secondaryToStream()
```
    Specified by:
    
    secondaryToStream in interface com.aol.cyclops.control.Xor<ST,PT>
  - flatMap
```
public <LT1,RT1> com.aol.cyclops.control.Xor<LT1,RT1> flatMap(java.util.function.Function<? super PT,? extends com.aol.cyclops.types.MonadicValue2<? extends LT1,? extends RT1>> mapper)
```
    Specified by:
    
    flatMap in interface com.aol.cyclops.control.Xor<ST,PT>
    
    Specified by:
    
    flatMap in interface com.aol.cyclops.types.MonadicValue2<ST,PT>
  - secondaryFlatMap
```
public <LT1,RT1> com.aol.cyclops.control.Xor<LT1,RT1> secondaryFlatMap(java.util.function.Function<? super ST,? extends com.aol.cyclops.control.Xor<LT1,RT1>> mapper)
```
    Specified by:
    
    secondaryFlatMap in interface com.aol.cyclops.control.Xor<ST,PT>
  - secondaryToPrimayFlatMap
```
public com.aol.cyclops.control.Xor<ST,PT> secondaryToPrimayFlatMap(java.util.function.Function<? super ST,? extends com.aol.cyclops.control.Xor<ST,PT>> fn)
```
    Specified by:
    
    secondaryToPrimayFlatMap in interface com.aol.cyclops.control.Xor<ST,PT>
  - peek
```
public void peek(java.util.function.Consumer<? super ST> stAction,
                 java.util.function.Consumer<? super PT> ptAction)
```
    Specified by:
    
    peek in interface com.aol.cyclops.control.Xor<ST,PT>
  - isPrimary
```
public boolean isPrimary()
```
    Specified by:
    
    isPrimary in interface com.aol.cyclops.control.Xor<ST,PT>
  - isSecondary
```
public boolean isSecondary()
```
    Specified by:
    
    isSecondary in interface com.aol.cyclops.control.Xor<ST,PT>
  - combine
```
public <T2,R> com.aol.cyclops.control.Xor<ST,R> combine(com.aol.cyclops.types.Value<? extends T2> app,
                                                        java.util.function.BiFunction<? super PT,? super T2,? extends R> fn)
```
    Specified by:
    
    combine in interface com.aol.cyclops.control.Xor<ST,PT>
    
    Specified by:
    
    combine in interface com.aol.cyclops.types.Combiner<PT>

Class XorType.Box<ST,PT>

Nested Class Summary

Nested classes/interfaces inherited from interface com.aol.cyclops.hkt.cyclops.XorType

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.hkt.cyclops.XorType

Methods inherited from interface com.aol.cyclops.hkt.alias.Convert

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

Box

Method Detail

secondaryMap

visit

narrow

get

isPresent

toString

equals

hashCode

filter

secondaryToPrimayMap

map

secondaryPeek

peek

swap

toIor

matches

secondaryValue

secondaryGet

secondaryToOptional

secondaryToStream

flatMap

secondaryFlatMap

secondaryToPrimayFlatMap

peek

isPrimary

isSecondary

combine