Convertable (cyclops-react 2.0.0-MI1 API)

Type Parameters:

T - Type of this convertable

All Superinterfaces:

Fn0<T>, org.jooq.lambda.function.Function0<T>, java.lang.Iterable<T>, java.util.function.Supplier<T>, Visitable<T>

All Known Subinterfaces:

AnyMValue<W,T>, Either<ST,PT>, Either3<LT1,LT2,RT>, Either4<LT1,LT2,LT3,RT>, Either5<LT1,LT2,LT3,LT4,RT>, Eval<T>, Ior<ST,PT>, Maybe<T>, MonadicValue<T>, Trampoline<T>, Try<T,X>, Value<T>, Xor<ST,PT>

All Known Implementing Classes:

Convertable.SupplierToConvertable, Either.Lazy, Either.Left, Either.Right, Either3.Lazy, Either3.Left1, Either3.Left2, Either3.Right, Either4.Lazy, Either4.Left1, Either4.Left2, Either4.Left3, Either4.Right, Either5.Lazy, Either5.Left1, Either5.Left2, Either5.Left3, Either5.Left4, Either5.Right, Eval.Module.Always, Eval.Module.Later, Future, Ior.Both, Ior.Primary, Ior.Secondary, Maybe.Just, Maybe.Lazy, Maybe.Nothing, Try.Failure, Try.Success, Value.ValueImpl, ValueSubscriber, Xor.Primary, Xor.Secondary
```
public interface Convertable<T>
extends java.lang.Iterable<T>, Fn0<T>, Visitable<T>
```
Interface that represents a single value that can be converted into a List, Stream or Optional

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Convertable.SupplierToConvertable<T>
- Nested classes/interfaces inherited from interface cyclops.function.Fn0
  Fn0.FunctionalOperations<R>, Fn0.Instances, Fn0.SupplierKind<R>

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Convertable.SupplierToConvertable<T>`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <R,A> R`	`collect(java.util.stream.Collector<? super T,A,R> collector)` Collect the contents of the monad wrapped by this AnyM into supplied collector A mutable reduction operation equivalent to Stream#collect
`static <T> Convertable<T>`	`fromSupplier(java.util.function.Supplier<T> supplier)` Construct a Convertable from a Supplier
`T`	`get()` Apply this function to the arguments.
`default boolean`	`isPresent()`
`default java.util.Iterator<T>`	`iterator()`
`default T`	`orElse(T value)` Get the contained value or else the provided alternative
`default T`	`orElseGet(java.util.function.Supplier<? extends T> value)` An equivalent operation to `Optional.orElseGet(Supplier)` Returns a value generated by the provided Supplier if this Convertable is empty or contains a null value.
`default <X extends java.lang.Throwable> T`	`orElseThrow(java.util.function.Supplier<? extends X> ex)` Get the contained value or throw an exception if null
`default java.util.concurrent.CompletableFuture<T>`	`toCompletableFuture()`
`default java.util.concurrent.CompletableFuture<T>`	`toCompletableFutureAsync()`
`default java.util.concurrent.CompletableFuture<T>`	`toCompletableFutureAsync(java.util.concurrent.Executor exec)`
`default Future<T>`	`toFuture()`
`default Future<T>`	`toFutureWAsync()`
`default Future<T>`	`toFutureWAsync(java.util.concurrent.Executor ex)` This convertable converted to a Future asyncrhonously using the supplied Executor
`default java.util.Optional<T>`	`toOptional()`
`default java.util.stream.Stream<T>`	`toStream()`
`default <R> R`	`visit(java.util.function.Function<? super T,? extends R> present, java.util.function.Supplier<? extends R> absent)` The provided function is executed with the value stored in this Visitable if one is present, otherwise the provided Supplier is executed instead.

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

Methods inherited from interface cyclops.function.Fn0
andThen, fnTo, functionOps, lift, lift, liftF, liftOpt, liftTry, memoize, memoize, run, suspend, λ, λv

Methods inherited from interface org.jooq.lambda.function.Function0
apply, apply, from, toSupplier

- Method Detail
  - collect
```
default <R,A> R collect(java.util.stream.Collector<? super T,A,R> collector)
```
    Collect the contents of the monad wrapped by this AnyM into supplied collector A mutable reduction operation equivalent to Stream#collect
```
 
      AnyM<Integer> monad1 = AnyM.fromStream(Stream.of(1,2,3));
      AnyM<Integer> monad2 = AnyM.fromOptional(Optional.of(1));

      List<Integer> list1 = monad1.collect(Collectors.toList());
      List<Integer> list2 = monad2.collect(Collectors.toList());

 
 
```
    Parameters:
    
    collector - JDK collector to perform mutable reduction
    
    Returns:
    
    Reduced value
  - visit
```
default <R> R visit(java.util.function.Function<? super T,? extends R> present,
                    java.util.function.Supplier<? extends R> absent)
```
    Description copied from interface: Visitable
    
    The provided function is executed with the value stored in this Visitable if one is present, otherwise the provided Supplier is executed instead.
    
    Specified by:
    
    visit in interface Visitable<T>
    
    Parameters:
    
    present - Function to execute if this Visitable has a value
    
    absent - Supplier to execute if this Visitable does not have a Value
    
    Returns:
    
    Result of the executed Function or Supplier
  - isPresent
```
default boolean isPresent()
```
    Returns:
    
    True if value exists and is non-null
  - fromSupplier
```
static <T> Convertable<T> fromSupplier(java.util.function.Supplier<T> supplier)
```
    Construct a Convertable from a Supplier
    
    Parameters:
    
    supplier - That returns the convertable value
    
    Returns:
    
    Convertable
  - get
```
T get()
```
    Description copied from interface: org.jooq.lambda.function.Function0
    
    Apply this function to the arguments.
    
    Specified by:
    
    get in interface org.jooq.lambda.function.Function0<T>
    
    Specified by:
    
    get in interface java.util.function.Supplier<T>
    
    Returns:
    
    Contained value, maybe null
  - orElseGet
```
default T orElseGet(java.util.function.Supplier<? extends T> value)
```
    An equivalent operation to Optional.orElseGet(Supplier) Returns a value generated by the provided Supplier if this Convertable is empty or contains a null value.
    
    Parameters:
    
    value - Supplier to generate value if this convertable is empty
    
    Returns:
    
    Value contained in this convertable or the value returned by the supplier if this convertable is empty
  - toOptional
```
default java.util.Optional<T> toOptional()
```
    Returns:
    
    Optional that wraps contained value, Optional.empty if value is null
  - toStream
```
default java.util.stream.Stream<T> toStream()
```
    Returns:
    
    Stream containing value returned by get(), Empty Stream if null
  - orElse
```
default T orElse(T value)
```
    Get the contained value or else the provided alternative
    
    Parameters:
    
    value -
    
    Returns:
    
    the value of this convertable (if not empty) or else the specified value
  - orElseThrow
```
default <X extends java.lang.Throwable> T orElseThrow(java.util.function.Supplier<? extends X> ex)
                                               throws X extends java.lang.Throwable
```
    Get the contained value or throw an exception if null
    
    Parameters:
    
    ex - Supplier that returns an exception if this value is empty
    
    Returns:
    
    Value of this value if present
    
    Throws:
    
    X - Exception type returned by provided Supplier
    
    X extends java.lang.Throwable
  - iterator
```
default java.util.Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
  - toFuture
```
default Future<T> toFuture()
```
    Returns:
    
    This convertable converted to a Future
  - toFutureWAsync
```
default Future<T> toFutureWAsync()
```
    Returns:
    
    This convertable converted to a Future asyncrhonously
  - toFutureWAsync
```
default Future<T> toFutureWAsync(java.util.concurrent.Executor ex)
```
    This convertable converted to a Future asyncrhonously using the supplied Executor
    
    Parameters:
    
    ex - Executor to execute the conversion on
    
    Returns:
    
    This convertable converted to a Future asyncrhonously
  - toCompletableFuture
```
default java.util.concurrent.CompletableFuture<T> toCompletableFuture()
```
    Returns:
    
    A CompletableFuture, populated immediately by a call to get
  - toCompletableFutureAsync
```
default java.util.concurrent.CompletableFuture<T> toCompletableFutureAsync()
```
    Returns:
    
    A CompletableFuture populated asynchronously on the Common ForkJoinPool by calling get
  - toCompletableFutureAsync
```
default java.util.concurrent.CompletableFuture<T> toCompletableFutureAsync(java.util.concurrent.Executor exec)
```
    Parameters:
    
    exec - Executor to asyncrhonously populate the CompletableFuture
    
    Returns:
    
    A CompletableFuture populated asynchronously on the supplied Executor by calling get

Interface Convertable<T>

Nested Class Summary

Nested classes/interfaces inherited from interface cyclops.function.Fn0

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from interface cyclops.function.Fn0

Methods inherited from interface org.jooq.lambda.function.Function0

Method Detail

collect

visit

isPresent

fromSupplier

get

orElseGet

toOptional

toStream

orElse

orElseThrow

iterator

toFuture

toFutureWAsync

toFutureWAsync

toCompletableFuture

toCompletableFutureAsync

toCompletableFutureAsync