com.aol.cyclops.types

Interface Convertable<T>

Type Parameters:

T -

All Superinterfaces:

java.lang.Iterable<T>, java.util.function.Supplier<T>

All Known Subinterfaces:

AnyMValue<T>, Applicativable<T>, ConvertableFunctor<T>, Eval<T>, FeatureToggle<F>, Ior<ST,PT>, Maybe<T>, Trampoline<T>, Try<T,X>, Value<T>, Xor<ST,PT>

All Known Implementing Classes:

AnyMValueImpl, Convertable.SupplierToConvertable, Eval.Always, Eval.Later, Eval.Now, FeatureToggle.Disabled, FeatureToggle.Enabled, FutureW, Ior.Both, Ior.Primary, Ior.Secondary, LazyImmutable, Maybe.Just, Maybe.Nothing, Mutable, MutableBoolean, MutableByte, MutableChar, MutableDouble, MutableFloat, MutableInt, MutableLong, MutableShort, Try.Failure, Try.Success, Value.ValueImpl, Xor.Primary, Xor.Secondary

public interface Convertable<T>
extends java.lang.Iterable<T>, java.util.function.Supplier<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>

Method Summary

Modifier and Type	Method and Description
static <T> Convertable<T>	fromSupplier(java.util.function.Supplier<T> supplier) Construct a Convertable from a Supplier
T	get()
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)
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.atomic.AtomicReference<T>	toAtomicReference()
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 FutureW<T>	toFutureW()
default java.util.List<T>	toList()
default java.util.Optional<T>	toOptional()
default java.util.Optional<java.util.concurrent.atomic.AtomicReference<T>>	toOptionalAtomicReference()
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)

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

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()

Specified by:

get in interface java.util.function.Supplier<T>

Returns:

Contained value, maybe null

visit

default <R> R visit(java.util.function.Function<? super T,? extends R> present,
                    java.util.function.Supplier<? extends R> absent)

orElseGet

default T orElseGet(java.util.function.Supplier<? extends T> value)

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

toAtomicReference

default java.util.concurrent.atomic.AtomicReference<T> toAtomicReference()

Returns:

An AtomicReference containing value returned by get()

toOptionalAtomicReference

default java.util.Optional<java.util.concurrent.atomic.AtomicReference<T>> toOptionalAtomicReference()

Returns:

An Optional AtomicReference containing value returned by get(), Optional.empty if get() returns null

orElse

default T orElse(T value)

Get the contained value or else the provided alternative

Parameters:

value -

Returns:

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 -

Returns:

Throws:

X

X extends java.lang.Throwable

toList

default java.util.List<T> toList()

Returns:

A List containing value returned by get(), if get() returns null an Empty List is returned

iterator

default java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

toFutureW

default FutureW<T> toFutureW()

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