FutureType (cyclops-typeclasses 8.3.0 API)

java.lang.Object
- com.aol.cyclops.control.FutureW<T>
- - com.aol.cyclops.hkt.cyclops.FutureType<T>

Type Parameters:

T - Data type stored within the FutureW

All Implemented Interfaces:

com.aol.cyclops.hkt.alias.Convert<com.aol.cyclops.hkt.alias.Higher<FutureType.µ,T>>, com.aol.cyclops.hkt.alias.Higher<FutureType.µ,T>, com.aol.cyclops.types.applicative.ApplicativeFunctor<T>, com.aol.cyclops.types.Combiner<T>, com.aol.cyclops.types.Convertable<T>, com.aol.cyclops.types.ConvertableFunctor<T>, com.aol.cyclops.types.Filterable<T>, com.aol.cyclops.types.FlatMap<T>, com.aol.cyclops.types.Foldable<T>, com.aol.cyclops.types.Functor<T>, com.aol.cyclops.types.MonadicValue<T>, com.aol.cyclops.types.MonadicValue1<T>, com.aol.cyclops.types.To<com.aol.cyclops.control.FutureW<T>>, com.aol.cyclops.types.Unit<T>, com.aol.cyclops.types.Value<T>, com.aol.cyclops.types.Visitable<T>, com.aol.cyclops.types.Zippable<T>, java.lang.Iterable<T>, java.util.function.Predicate<T>, java.util.function.Supplier<T>, org.derive4j.hkt.__<FutureType.µ,T>, org.reactivestreams.Publisher<T>
```
public final class FutureType<T>
extends com.aol.cyclops.control.FutureW<T>
implements com.aol.cyclops.hkt.alias.Higher<FutureType.µ,T>
```
Simulates Higher Kinded Types for FutureW's FutureWType is a FutureW and a Higher Kinded Type (FutureWType.µ,T)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FutureType.µ
Witness type
- 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>

Nested Classes
Modifier and Type	Class and Description
`static class`	`FutureType.µ` Witness type

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> FutureType<T>`	`empty()` An empty FutureW
`static <T> FutureType<T>`	`fromIterable(java.lang.Iterable<T> iterable)` Construct a FutureW syncrhonously that contains a single value extracted from the supplied Iterable
`static <T> FutureType<T>`	`fromIterable(java.lang.Iterable<T> iterable, java.util.concurrent.Executor ex)` Construct a FutureW asyncrhonously that contains a single value extracted from the supplied Iterable
`static <T> FutureType<T>`	`fromPublisher(org.reactivestreams.Publisher<T> pub)` Construct a FutureW syncrhonously that contains a single value extracted from the supplied reactive-streams Publisher
`static <T> FutureType<T>`	`fromPublisher(org.reactivestreams.Publisher<T> pub, java.util.concurrent.Executor ex)` Construct a FutureW asyncrhonously that contains a single value extracted from the supplied reactive-streams Publisher
`static <T> FutureType<T>`	`future()` An empty FutureType
`com.aol.cyclops.control.FutureW<T>`	`narrow()`
`static <T> com.aol.cyclops.control.FutureW<T>`	`narrow(com.aol.cyclops.hkt.alias.Higher<FutureType.µ,T> futureW)` Convert the HigherKindedType definition for a FutureW into
`static <T> java.util.concurrent.CompletableFuture<T>`	`narrowCompletableFuture(com.aol.cyclops.hkt.alias.Higher<FutureType.µ,T> futureW)` Convert the HigherKindedType definition for a FutureW into
`static <T> FutureType<T>`	`narrowK(com.aol.cyclops.hkt.alias.Higher<FutureType.µ,T> future)` Convert the raw Higher Kinded Type for FutureType types into the FutureType type definition class
`static <T> FutureType<T>`	`of(java.util.concurrent.CompletableFuture<T> f)` Create a FutureType instance from the supplied CompletableFuture
`static <T> FutureType<T>`	`ofError(java.lang.Throwable error)` Construct a completed-with-error FutureW from the given Exception
`static <T> FutureType<T>`	`ofResult(T result)` Construct a successfully completed FutureW from the given value
`static <T> FutureType<T>`	`ofSupplier(java.util.function.Supplier<T> s)` Create a FutureW object that asyncrhonously populates using the Common ForkJoinPool from the user provided Supplier
`static <T> FutureType<T>`	`ofSupplier(java.util.function.Supplier<T> s, java.util.concurrent.Executor ex)` Create a FutureW object that asyncrhonously populates using the provided Executor and Supplier
`static <T> FutureType<T>`	`schedule(long delay, java.util.concurrent.ScheduledExecutorService ex, java.util.function.Supplier<T> t)` Schedule the population of a FutureW from the provided Supplier after the specified delay.
`static <T> FutureType<T>`	`schedule(java.lang.String cron, java.util.concurrent.ScheduledExecutorService ex, java.util.function.Supplier<T> t)` Schedule the population of a FutureW from the provided Supplier, the provided Cron (Quartz format) expression will be used to trigger the population of the FutureW.
`static <T> FutureType<T>`	`widen(com.aol.cyclops.control.FutureW<T> futureW)` Convert a FutureW to a simulated HigherKindedType that captures FutureW nature and FutureW element data type separately.

Methods inherited from class com.aol.cyclops.control.FutureW
accumulate, accumulate, accumulate, accumulateSuccess, accumulateSuccess, accumulateSuccess, allOf, anyOf, cancel, canEqual, cast, coflatMap, combine, combine, combineEager, complete, completeExceptionally, equals, filter, filterNot, firstSuccess, flatMap, flatMapCf, flatMapIterable, flatMapPublisher, flatten, fromTry, fromTry, get, getFuture, hashCode, isCancelled, isDone, isFailed, isPresent, isSuccess, iterator, map, map, map, matches, mkString, nest, notNull, ofType, patternMatch, peek, quorum, recover, sequence, sequence, stream, toCompletableFuture, toCompletableFutureAsync, toCompletableFutureAsync, toFutureW, toFutureWAsync, toFutureWAsync, toIor, toOptional, toString, toXor, trampoline, unit, zip, zip, zip, zip, zip, zip, zip

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

Methods inherited from interface com.aol.cyclops.hkt.alias.Higher
apply_, apply, then

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

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.MonadicValue1
anyM

Methods inherited from interface com.aol.cyclops.types.Value
collect, fold, fold, generate, iterate, mapReduce, newSubscriber, of, 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, toXor, 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, toOptionalAtomicReference, toStream, visit

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

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

- Method Detail
  - empty
```
public static <T> FutureType<T> empty()
```
    An empty FutureW
    
    Returns:
    
    A FutureType that wraps a CompletableFuture with a null result
  - future
```
public static <T> FutureType<T> future()
```
    An empty FutureType
    
    Returns:
    
    A FutureType that wraps a CompletableFuture with a null result
  - narrowK
```
public static <T> FutureType<T> narrowK(com.aol.cyclops.hkt.alias.Higher<FutureType.µ,T> future)
```
    Convert the raw Higher Kinded Type for FutureType types into the FutureType type definition class
    
    Parameters:
    
    future - HKT encoded list into a FutureType
    
    Returns:
    
    FutureType
  - fromPublisher
```
public static <T> FutureType<T> fromPublisher(org.reactivestreams.Publisher<T> pub,
                                              java.util.concurrent.Executor ex)
```
    Construct a FutureW asyncrhonously that contains a single value extracted from the supplied reactive-streams Publisher
```
  
   ReactiveSeq<Integer> stream =  ReactiveSeq.of(1,2,3);
        
        FutureType<Integer> future = FutureType.fromPublisher(stream,ex);
        
        //FutureType[1]
 
 
 
```
    Parameters:
    
    pub - Publisher to extract value from
    
    ex - Executor to extract value on
    
    Returns:
    
    FutureType populated asyncrhonously from Publisher
  - fromIterable
```
public static <T> FutureType<T> fromIterable(java.lang.Iterable<T> iterable,
                                             java.util.concurrent.Executor ex)
```
    Construct a FutureW asyncrhonously that contains a single value extracted from the supplied Iterable
```
  
  ReactiveSeq<Integer> stream =  ReactiveSeq.of(1,2,3);
        
        FutureType<Integer> future = FutureType.fromIterable(stream,ex);
        
        //FutureType[1]
 
 
 
```
    Parameters:
    
    iterable - Iterable to generate a FutureW from
    
    ex - Executor to extract value on
    
    Returns:
    
    FutureType populated asyncrhonously from Iterable
  - fromPublisher
```
public static <T> FutureType<T> fromPublisher(org.reactivestreams.Publisher<T> pub)
```
    Construct a FutureW syncrhonously that contains a single value extracted from the supplied reactive-streams Publisher
```
  
   ReactiveSeq<Integer> stream =  ReactiveSeq.of(1,2,3);
        
        FutureType<Integer> future = FutureType.fromPublisher(stream);
        
        //FutureW[1]
 
 
 
```
    Parameters:
    
    pub - Publisher to extract value from
    
    Returns:
    
    FutureType populated syncrhonously from Publisher
  - fromIterable
```
public static <T> FutureType<T> fromIterable(java.lang.Iterable<T> iterable)
```
    Construct a FutureW syncrhonously that contains a single value extracted from the supplied Iterable
```
  
  ReactiveSeq<Integer> stream =  ReactiveSeq.of(1,2,3);
        
        FutureType<Integer> future = FutureType.fromIterable(stream);
        
        //FutureType[1]
 
 
 
```
    Parameters:
    
    iterable - Iterable to extract value from
    
    Returns:
    
    FutureType populated syncrhonously from Iterable
  - of
```
public static <T> FutureType<T> of(java.util.concurrent.CompletableFuture<T> f)
```
    Create a FutureType instance from the supplied CompletableFuture
    
    Parameters:
    
    f - CompletableFuture to wrap as a FutureW
    
    Returns:
    
    FutureType wrapping the supplied CompletableFuture
  - schedule
```
public static <T> FutureType<T> schedule(java.lang.String cron,
                                         java.util.concurrent.ScheduledExecutorService ex,
                                         java.util.function.Supplier<T> t)
```
    Schedule the population of a FutureW from the provided Supplier, the provided Cron (Quartz format) expression will be used to trigger the population of the FutureW. The provided ScheduledExecutorService provided the thread on which the Supplier will be executed.
```
  
  
    FutureType<String> future = FutureType.schedule("* * * * * ?", Executors.newScheduledThreadPool(1), ()->"hello");
    
    //FutureType["hello"]
 
 
```
    Parameters:
    
    cron - Cron expression in Quartz format
    
    ex - ScheduledExecutorService used to execute the provided Supplier
    
    t - The Supplier to execute to populate the FutureW
    
    Returns:
    
    FutureW populated on a Cron based Schedule
  - schedule
```
public static <T> FutureType<T> schedule(long delay,
                                         java.util.concurrent.ScheduledExecutorService ex,
                                         java.util.function.Supplier<T> t)
```
    Schedule the population of a FutureW from the provided Supplier after the specified delay. The provided ScheduledExecutorService provided the thread on which the Supplier will be executed.
```
  
  
    FutureW<String> future = FutureW.schedule(10l, Executors.newScheduledThreadPool(1), ()->"hello");
    
    //FutureW["hello"]
 
 
```
    Parameters:
    
    delay - Delay after which the FutureW should be populated
    
    ex - ScheduledExecutorService used to execute the provided Supplier
    
    t - he Supplier to execute to populate the FutureW
    
    Returns:
    
    FutureW populated after the specified delay
  - ofSupplier
```
public static <T> FutureType<T> ofSupplier(java.util.function.Supplier<T> s)
```
    Create a FutureW object that asyncrhonously populates using the Common ForkJoinPool from the user provided Supplier
    
    Parameters:
    
    s - Supplier to asynchronously populate results from
    
    Returns:
    
    FutureW asynchronously populated from the Supplier
  - ofSupplier
```
public static <T> FutureType<T> ofSupplier(java.util.function.Supplier<T> s,
                                           java.util.concurrent.Executor ex)
```
    Create a FutureW object that asyncrhonously populates using the provided Executor and Supplier
    
    Parameters:
    
    s - Supplier to asynchronously populate results from
    
    ex - Executro to asynchronously populate results with
    
    Returns:
    
    FutureW asynchronously populated from the Supplier
  - ofResult
```
public static <T> FutureType<T> ofResult(T result)
```
    Construct a successfully completed FutureW from the given value
    
    Parameters:
    
    result - To wrap inside a FutureW
    
    Returns:
    
    FutureW containing supplied result
  - ofError
```
public static <T> FutureType<T> ofError(java.lang.Throwable error)
```
    Construct a completed-with-error FutureW from the given Exception
    
    Parameters:
    
    error - To wrap inside a FutureW
    
    Returns:
    
    FutureW containing supplied error
  - widen
```
public static <T> FutureType<T> widen(com.aol.cyclops.control.FutureW<T> futureW)
```
    Convert a FutureW to a simulated HigherKindedType that captures FutureW nature and FutureW element data type separately. Recover via @see FutureWType#narrow If the supplied FutureW implements FutureWType it is returned already, otherwise it is wrapped into a FutureW implementation that does implement FutureWType
    
    Parameters:
    
    FutureW - FutureW to widen to a FutureWType
    
    Returns:
    
    FutureWType encoding HKT info about FutureWs
  - narrow
```
public static <T> com.aol.cyclops.control.FutureW<T> narrow(com.aol.cyclops.hkt.alias.Higher<FutureType.µ,T> futureW)
```
    Convert the HigherKindedType definition for a FutureW into
    
    Parameters:
    
    FutureW - Type Constructor to convert back into narrowed type
    
    Returns:
    
    FutureW from Higher Kinded Type
  - narrowCompletableFuture
```
public static <T> java.util.concurrent.CompletableFuture<T> narrowCompletableFuture(com.aol.cyclops.hkt.alias.Higher<FutureType.µ,T> futureW)
```
    Convert the HigherKindedType definition for a FutureW into
    
    Parameters:
    
    Future - Type Constructor to convert back into narrowed type
    
    Returns:
    
    CompletableFuture from Higher Kinded Type
  - narrow
```
public com.aol.cyclops.control.FutureW<T> narrow()
```
    Returns:
    
    This back as a FutureW

Class FutureType<T>

Nested Class Summary

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

Method Summary

Methods inherited from class com.aol.cyclops.control.FutureW

Methods inherited from class java.lang.Object

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

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

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.MonadicValue1

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

Method Detail

empty

future

narrowK

fromPublisher

fromIterable

fromPublisher

fromIterable

of

schedule

schedule

ofSupplier

ofSupplier

ofResult

ofError

widen

narrow

narrowCompletableFuture

narrow