Value (cyclops-react 1.0.2 API)

Type Parameters:

T - Data type of element in this value

All Superinterfaces:

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

All Known Subinterfaces:

AnyMValue<T>, ApplicativeFunctor<T>, Combiner<T>, ConvertableFunctor<T>, Eval<T>, FeatureToggle<F>, Ior<ST,PT>, Matchable.ValueAndOptionalMatcher<T>, Maybe<T>, MonadicValue<T>, MonadicValue1<T>, MonadicValue2<T1,T2>, Trampoline<T>, TransformerValue<T>, Try<T,X>, Xor<ST,PT>

All Known Implementing Classes:

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, Mutable, MutableBoolean, MutableByte, MutableChar, MutableDouble, MutableFloat, MutableInt, MutableLong, MutableShort, OptionalTValue, Try.Failure, Try.Success, TryTValue, Value.ValueImpl, ValueSubscriber, Xor.Primary, Xor.Secondary, XorTValue

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface Value<T>
extends java.util.function.Supplier<T>, Foldable<T>, Convertable<T>, org.reactivestreams.Publisher<T>, java.util.function.Predicate<T>, Zippable<T>
```
A data type that stores at most 1 Values

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Value.ValueImpl<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`	`Value.ValueImpl<T>`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default <R,A> R`	`collect(java.util.stream.Collector<? super T,A,R> collector)` An equivalent operation to `Stream.collect(Collector)`
`default T`	`fold(Monoid<T> monoid)` Use the supplied Monoid to reduce this Value to a single result (unwraps the value stored in this Value if the provided Monoid instance obeys the Monoid laws)
`default T`	`fold(T identity, java.util.function.BinaryOperator<T> accumulator)` Use the supplied identity value and function to reduce this Value to a single result (unwraps the value stored in this Value if the provided monoid combination instance obeys the Monoid laws)
`default ReactiveSeq<T>`	`generate()`
`default ReactiveSeq<T>`	`iterate(java.util.function.UnaryOperator<T> fn)` Use the value stored in this Value to seed a Stream generated from the provided function
`default java.util.Iterator<T>`	`iterator()`
`default <E> E`	`mapReduce(Reducer<E> monoid)` Attempt to map this Sequence to the same type as the supplied Monoid (Reducer) Then use Monoid to reduce values
`default 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.
`default ValueSubscriber<T>`	`newSubscriber()`
`static <T> Value<T>`	`of(java.util.function.Supplier<T> supplier)` Construct a generic Value from the provided Supplier
`default ReactiveSeq<T>`	`stream()`
`default void`	`subscribe(org.reactivestreams.Subscriber<? super T> sub)`
`default boolean`	`test(T t)`
`default DequeX<T>`	`toDequeX()` Returns a DequeX created with a list which is result of a get() call.
`default Eval<T>`	`toEvalAlways()` Return the value of this object, evaluated always.
`default Eval<T>`	`toEvalLater()` Return the value, evaluated later.
`default Eval<T>`	`toEvalNow()` Return the value, evaluated right now.
`default FeatureToggle<T>`	`toFeatureToggle()` Returns a enabled FeatureToggle in case there is an Optional in this object, otherwise returns a disabled FeatureToogle
`default LazyFutureStream<T>`	`toFutureStream()` Returns a new LazyFutureStream with the data-flow open with an array of one-off-suppliers.
`default LazyFutureStream<T>`	`toFutureStream(LazyReact reactor)` Creates a LazyFutureStream with the input LazyReact the data-flow initialized with an array of one-off-suppliers.
`default Ior<?,T>`	`toIor()` Return an Ior that can be this object or a Ior.primary or Ior.secondary
`default LazyImmutable<T>`	`toLazyImmutable()`
`default java.util.List<T>`	`toList()`
`default ListX<T>`	`toListX()` Returns a ListX created with a list which is result of a get() call.
`default Maybe<T>`	`toMaybe()` Returns a function result or a supplier result.
`default Mutable<T>`	`toMutable()`
`default PBagX<T>`	`toPBagX()` Returns a PBagX created with a list which is result of a get() call.
`default POrderedSetX<T>`	`toPOrderedSetX()` Returns a POrderedSetX created with a list which is result of a get() call.
`default PQueueX<T>`	`toPQueueX()` Returns a PQueueX created with a list which is result of a get() call.
`default PSetX<T>`	`toPSetX()` Returns a PSetX created with a list which is result of a get() call.
`default PStackX<T>`	`toPStackX()` Returns a PStackX created with a list which is result of a get() call.
`default PVectorX<T>`	`toPVectorX()` Returns a PVectosX created with a list which is result of a get() call.
`default QueueX<T>`	`toQueueX()` REturns a QueueX created with a list which is result of a get() call.
`default SetX<T>`	`toSetX()` Returns a SetX created with a list which is result of a get() call.
`default SimpleReactStream<T>`	`toSimpleReact()` Returns a SimpleReactStream with the dataflow open with an array of one-off-suppliers
`default SimpleReactStream<T>`	`toSimpleReact(SimpleReact reactor)` Returns the input SimpleReact with the data-flow initialized with an array of one-off-suppliers.
`default SortedSetX<T>`	`toSortedSetX()` Returns a SortedSetX created with a list which is result of a get() call.
`default Try<T,java.lang.Throwable>`	`toTry()`
`default <X extends java.lang.Throwable> Try<T,X>`	`toTry(java.lang.Class<X>... classes)` Convert this Value to a Try that will catch the provided exception types on subsequent operations
`default <X extends java.lang.Throwable> Try<T,X>`	`toTry(X throwable)`
`default Xor<?,T>`	`toXor()`
`default <ST> Xor<ST,T>`	`toXor(ST secondary)` Convert to an Xor where the secondary value will be used if no primary value is present
`default ListX<?>`	`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
  - iterator
```
default java.util.Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Convertable<T>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
  - test
```
default boolean test(T t)
```
    Specified by:
    
    test in interface java.util.function.Predicate<T>
  - newSubscriber
```
default ValueSubscriber<T> newSubscriber()
```
    Returns:
    
    A factory class generating Values from reactive-streams Subscribers
  - subscribe
```
default void subscribe(org.reactivestreams.Subscriber<? super T> sub)
```
    Specified by:
    
    subscribe in interface org.reactivestreams.Publisher<T>
  - of
```
static <T> Value<T> of(java.util.function.Supplier<T> supplier)
```
    Construct a generic Value from the provided Supplier
    
    Parameters:
    
    supplier - Value supplier
    
    Returns:
    
    Value wrapping a value that can be generated from the provided Supplier
  - stream
```
default ReactiveSeq<T> stream()
```
    Specified by:
    
    stream in interface Foldable<T>
    
    Returns:
    
    this Foldable converted to a Stream (ReactiveSeq) of it's elements
  - unapply
```
default ListX<?> unapply()
```
    Returns:
    
    This value converted to a List (for pattern matching purposes)
  - iterate
```
default ReactiveSeq<T> iterate(java.util.function.UnaryOperator<T> fn)
```
    Use the value stored in this Value to seed a Stream generated from the provided function
    
    Parameters:
    
    fn - Function to generate a Stream
    
    Returns:
    
    Stream generated from a seed value (the Value stored in this Value) and the provided function
  - generate
```
default ReactiveSeq<T> generate()
```
    Returns:
    
    A Stream that repeats the value stored in this Value over and over
  - mapReduce
```
default <E> E mapReduce(Reducer<E> monoid)
```
    Description copied from interface: Foldable
    Attempt to map this Sequence to the same type as the supplied Monoid (Reducer) Then use Monoid to reduce values
```
  
 ReactiveSeq.of("hello","2","world","4").mapReduce(Reducers.toCountInt());
 
 //4
 
 
```
    Specified by:
    
    mapReduce in interface Foldable<T>
    
    Parameters:
    
    monoid - Monoid to reduce values
    
    Returns:
    
    Reduce result
  - fold
```
default T fold(Monoid<T> monoid)
```
    Use the supplied Monoid to reduce this Value to a single result (unwraps the value stored in this Value if the provided Monoid instance obeys the Monoid laws)
    
    Parameters:
    
    monoid - Monoid to apply to this value
    
    Returns:
    
    The value stored inside this Value
  - fold
```
default T fold(T identity,
               java.util.function.BinaryOperator<T> accumulator)
```
    Use the supplied identity value and function to reduce this Value to a single result (unwraps the value stored in this Value if the provided monoid combination instance obeys the Monoid laws)
    
    Parameters:
    
    identity - Identity value
    
    accumulator - Accumulation function
    
    Returns:
    
    Result of applying Value stored in this value and the identity value to the provided accumulator
  - toLazyImmutable
```
default LazyImmutable<T> toLazyImmutable()
```
    Returns:
    
    LazyImmutable that has the same value as this Value
  - toMutable
```
default Mutable<T> toMutable()
```
    Returns:
    
    Mutable that has the same value as this Value
  - toXor
```
default Xor<?,T> toXor()
```
    Returns:
    
    Primary Xor that has the same value as this Value
  - toXor
```
default <ST> Xor<ST,T> toXor(ST secondary)
```
    Convert to an Xor where the secondary value will be used if no primary value is present
    
    Parameters:
    
    secondary - Value to use in case no primary value is present
    
    Returns:
    
    Primary Xor with same value as this Value, or a Secondary Xor with the provided Value if this Value is empty
  - toTry
```
default <X extends java.lang.Throwable> Try<T,X> toTry(X throwable)
```
    Parameters:
    
    throwable - Exception to use if this Value is empty
    
    Returns:
    
    Try that has the same value as this Value or the provided Exception
  - toTry
```
default Try<T,java.lang.Throwable> toTry()
```
    Returns:
    
    This Value converted to a Try. If this Value is empty the Try will contain a NoSuchElementException
  - toTry
```
default <X extends java.lang.Throwable> Try<T,X> toTry(java.lang.Class<X>... classes)
```
    Convert this Value to a Try that will catch the provided exception types on subsequent operations
    
    Parameters:
    
    classes - Exception classes to catch on subsequent operations
    
    Returns:
    
    This Value to converted to a Try.
  - toIor
```
default Ior<?,T> toIor()
```
    Return an Ior that can be this object or a Ior.primary or Ior.secondary
    
    Returns:
    
    new Ior
  - toFeatureToggle
```
default FeatureToggle<T> toFeatureToggle()
```
    Returns a enabled FeatureToggle in case there is an Optional in this object, otherwise returns a disabled FeatureToogle
    
    Returns:
    
    new FeatureToogle
  - toEvalNow
```
default Eval<T> toEvalNow()
```
    Return the value, evaluated right now.
    
    Returns:
    
    value evaluated from this object.
  - toEvalLater
```
default Eval<T> toEvalLater()
```
    Return the value, evaluated later.
    
    Returns:
    
    value evaluated from this object.
  - toEvalAlways
```
default Eval<T> toEvalAlways()
```
    Return the value of this object, evaluated always.
    
    Returns:
    
    value evaluated from this object.
  - toMaybe
```
default Maybe<T> toMaybe()
```
    Returns a function result or a supplier result. The first one if the function isn't null and the second one if it is.
    
    Returns:
    
    new Maybe with the result of a function or supplier.
  - toListX
```
default ListX<T> toListX()
```
    Returns a ListX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new ListX from current object
  - toSetX
```
default SetX<T> toSetX()
```
    Returns a SetX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new SetX from current object
  - toSortedSetX
```
default SortedSetX<T> toSortedSetX()
```
    Returns a SortedSetX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new SortedSetX from current object
  - toQueueX
```
default QueueX<T> toQueueX()
```
    REturns a QueueX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new QueueX from current object
  - toDequeX
```
default DequeX<T> toDequeX()
```
    Returns a DequeX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new DequeX from current object
  - toPStackX
```
default PStackX<T> toPStackX()
```
    Returns a PStackX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new PStackX from current object.
  - toPVectorX
```
default PVectorX<T> toPVectorX()
```
    Returns a PVectosX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new PVectorX from current object
  - toPQueueX
```
default PQueueX<T> toPQueueX()
```
    Returns a PQueueX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new PQueueX from current object
  - toPSetX
```
default PSetX<T> toPSetX()
```
    Returns a PSetX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new PSetX from current object
  - toPOrderedSetX
```
default POrderedSetX<T> toPOrderedSetX()
```
    Returns a POrderedSetX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new POrderedSetX from current object
  - toPBagX
```
default PBagX<T> toPBagX()
```
    Returns a PBagX created with a list which is result of a get() call. If this get() returns null the the list is the empty list.
    
    Returns:
    
    new PBagX from current object
  - mkString
```
default 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.
    
    Returns:
    
    String
  - toFutureStream
```
default LazyFutureStream<T> toFutureStream(LazyReact reactor)
```
    Creates a LazyFutureStream with the input LazyReact the data-flow initialized with an array of one-off-suppliers.
    
    Parameters:
    
    reactor -
    
    Returns:
    
    LazyFutureStream from input LazyReact
  - toFutureStream
```
default LazyFutureStream<T> toFutureStream()
```
    Returns a new LazyFutureStream with the data-flow open with an array of one-off-suppliers.
    
    Returns:
    
    new LazyFutureStream from current object
  - toSimpleReact
```
default SimpleReactStream<T> toSimpleReact(SimpleReact reactor)
```
    Returns the input SimpleReact with the data-flow initialized with an array of one-off-suppliers.
    
    Parameters:
    
    reactor -
    
    Returns:
    
    new SimpleReactStream from SimpleReact
  - toSimpleReact
```
default SimpleReactStream<T> toSimpleReact()
```
    Returns a SimpleReactStream with the dataflow open with an array of one-off-suppliers
    
    Returns:
    
    new SimpleReactStream from current object
  - collect
```
default <R,A> R collect(java.util.stream.Collector<? super T,A,R> collector)
```
    Description copied from interface: Convertable
    
    An equivalent operation to Stream.collect(Collector)
    
    Specified by:
    
    collect in interface Convertable<T>
    
    Parameters:
    
    collector - Collector to create new Collection
    
    Returns:
    
    Collected data
  - toList
```
default java.util.List<T> toList()
```
    Specified by:
    
    toList in interface Convertable<T>
    
    Returns:
    
    A List containing value returned by get(), if get() returns null an Empty List is returned

Interface Value<T>

Nested Class Summary

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

Method Summary

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 com.aol.cyclops.types.Zippable

Methods inherited from interface java.lang.Iterable

Method Detail

iterator

test

newSubscriber

subscribe

of

stream

unapply

iterate

generate

mapReduce

fold

fold

toLazyImmutable

toMutable

toXor

toXor

toTry

toTry

toTry

toIor

toFeatureToggle

toEvalNow

toEvalLater

toEvalAlways

toMaybe

toListX

toSetX

toSortedSetX

toQueueX

toDequeX

toPStackX

toPVectorX

toPQueueX

toPSetX

toPOrderedSetX

toPBagX

mkString

toFutureStream

toFutureStream

toSimpleReact

toSimpleReact

collect

toList