dev.acdcjunior.immutable

Class IOption<T>

java.lang.Object

dev.acdcjunior.immutable.IOption<T>

All Implemented Interfaces:

java.lang.Iterable<T>

Direct Known Subclasses:

IOption.None, IOption.Some

public abstract class IOption<T>
extends java.lang.Object
implements java.lang.Iterable<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IOption.None<T>
static class	IOption.Some<T>

Constructor Summary

Constructors

Constructor and Description
IOption()

Method Summary

Modifier and Type	Method and Description
abstract IOption<T>	filter(IFunction<? super T,java.lang.Boolean> fn)
abstract <R> IOption<R>	flatMap(IFunction<? super T,IOption<R>> fn)
abstract void	forEach(IConsumer<? super T> fn)
abstract T	get() Throws an exception if this option is IOption.None.
abstract T	getOrElse(ISupplier<? extends T> orElseFn)
abstract T	getOrElse(T orElse)
abstract IOption<T>	ifDefined(IConsumer<? super T> fn)
abstract IOption<T>	ifEmpty(ICommand fn)
boolean	isDefined()
abstract boolean	isEmpty()
java.util.Iterator<T>	iterator()
abstract <R> IOption<R>	map(IFunction<? super T,R> fn)
static <R> IOption<R>	none()
static <R> IOption<R>	ofNullable(R value)
abstract IOption<T>	orElse(ISupplier<? extends T> orElseFn)
abstract IOption<T>	orElse(T orElse)
abstract IOption<T>	orElseFlat(IOption<T> orElse)
abstract IOption<T>	orElseFlat(ISupplier<IOption<T>> orElseFn)
abstract T	orNull() Returns the current option's value or null if this option is IOption.None.
static <R> IOption<R>	some(R value)
abstract <L> IEither<L,T>	toEither(ISupplier<L> ifNone)
abstract java.util.List<T>	toList()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

IOption

public IOption()

Method Detail

toList

@NotNull
public abstract java.util.List<T> toList()

orNull

@Nullable
public abstract T orNull()

Returns the current option's value or null if this option is IOption.None.

Returns:

The value for this option, null if this option is IOption.None.

getOrElse

@NotNull
public abstract T getOrElse(@NotNull
                                      T orElse)

getOrElse

@NotNull
public abstract T getOrElse(@NotNull
                                      ISupplier<? extends T> orElseFn)

get

@NotNull
public abstract T get()

Throws an exception if this option is IOption.None.

Returns:

The value for this option.

Throws:

java.lang.IllegalStateException - if this option is IOption.None.

isEmpty

public abstract boolean isEmpty()

isDefined

public boolean isDefined()

ifEmpty

@NotNull
public abstract IOption<T> ifEmpty(@NotNull
                                             ICommand fn)

ifDefined

@NotNull
public abstract IOption<T> ifDefined(@NotNull
                                               IConsumer<? super T> fn)

orElse

@NotNull
public abstract IOption<T> orElse(@NotNull
                                            T orElse)

orElse

@NotNull
public abstract IOption<T> orElse(@NotNull
                                            ISupplier<? extends T> orElseFn)

orElseFlat

@NotNull
public abstract IOption<T> orElseFlat(@NotNull
                                                IOption<T> orElse)

orElseFlat

@NotNull
public abstract IOption<T> orElseFlat(@NotNull
                                                ISupplier<IOption<T>> orElseFn)

filter

@NotNull
public abstract IOption<T> filter(@NotNull
                                            IFunction<? super T,java.lang.Boolean> fn)

map

@NotNull
public abstract <R> IOption<R> map(@NotNull
                                             IFunction<? super T,R> fn)

flatMap

@NotNull
public abstract <R> IOption<R> flatMap(@NotNull
                                                 IFunction<? super T,IOption<R>> fn)

forEach

public abstract void forEach(@NotNull
                             IConsumer<? super T> fn)

iterator

@NotNull
public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

some

@NotNull
public static <R> IOption<R> some(@NotNull
                                            R value)

none

@NotNull
public static <R> IOption<R> none()

ofNullable

@NotNull
public static <R> IOption<R> ofNullable(@Nullable
                                                  R value)

toEither

@NotNull
public abstract <L> IEither<L,T> toEither(ISupplier<L> ifNone)