Package sprouts.impl

Class Sprouts

java.lang.Object

sprouts.impl.Sprouts

All Implemented Interfaces:

SproutsFactory

public final class Sprouts
extends Object
implements SproutsFactory

Exposes an API for configuring the SproutsFactory, which serves implementations of the various property types in the Sprouts library, like Event, Val, Var, Vals and Vars. The methods implemented here are used by the various factory methods of the sprouts API like Var.of(Object), Vals.of(Object, Object[]), Result.of(Object)...
So technically speaking, this is a configurable singleton, so be careful when using it as it effectively maintains global + mutable state!

Method Summary

Modifier and Type	Method	Description
<O, D> WeakAction<O,D>	actionOfWeak(O owner, BiConsumer<O,D> action)
<K, V> Association<K,V>	associationOf(Class<K> keyType, Class<V> valueType)
Channel	defaultChannel()	The default channel used for change events.
String	defaultId()	The default id for properties which do not have an id explicitly specified.
Channel	defaultObservableChannel()	The default channel used for Observable events, registered through the Observable.subscribe(Observer) method.
<T> ValDelegate<T>	delegateOf(Val<T> source, Channel channel, SingleChange change, @Nullable T newValue, @Nullable T oldValue)
<T> ValsDelegate<T>	delegateOf(Vals<T> source, SequenceChange changeType, int index, Vals<T> newValues, Vals<T> oldValues)
Event	event()
Event	eventOf(Event.Executor executor)
static SproutsFactory	factory()	A SproutsFactory is used by the various factory methods of this API like Var.of(Object), Vals.of(Object, Object[]), Result.of(Object)...
Pattern	idPattern()	The regex Pattern used to validate property ids.
<T, B> Var<B>	lensOf(Var<T> source, B nullObject, Lens<T,B> lens)
<T, B> Var<B>	lensOf(Var<T> source, Lens<T,B> lens)
<T, B> Var<B>	lensOfNullable(Class<B> type, Var<T> source, Lens<T,B> lens)
<O> WeakObserver<O>	observerOfWeak(O owner, Consumer<O> action)
<V> Result<V>	resultOf(Class<V> type)
<V> Result<V>	resultOf(Class<V> type, @Nullable V value)
<V> Result<V>	resultOf(Class<V> type, @Nullable V value, Iterable<Problem> problems)
<V> Result<V>	resultOf(Class<V> type, @Nullable V value, Problem problem)
<V> Result<V>	resultOf(Class<V> type, Iterable<Problem> problems)
<V> Result<V>	resultOf(Class<V> type, Problem problem)
<V> Result<V>	resultOf(V value)
<V> Result<V>	resultOf(V value, Iterable<Problem> problems)
<V> Result<List<V>>	resultOfList(Class<V> type, List<V> list)
<V> Result<List<V>>	resultOfList(Class<V> type, List<V> list, Iterable<Problem> problems)
<V> Result<List<V>>	resultOfList(Class<V> type, Problem problem)
<V> Result<V>	resultOfTry(Class<V> type, Supplier<V> supplier)
static void	setFactory(SproutsFactory factory)	Sets the factory to be used by the various factory methods of this API like Var.of(Object), Vals.of(Object, Object[]), Result.of(Object)...
<T> Tuple<T>	tupleOf(Class<T> type)
<T> Tuple<T>	tupleOf(Class<T> type, Iterable<T> iterable)
<T> Tuple<T>	tupleOf(Class<T> type, Maybe<T>... maybes)
<T> Tuple<T>	tupleOf(Class<T> type, T... items)
<T> Tuple<T>	tupleOf(Maybe<T> first, Maybe<T>... rest)
<T> Tuple<T>	tupleOf(T first, T... rest)
<T> Tuple<@Nullable T>	tupleOfNullable(Class<T> type)
<T> Tuple<@Nullable T>	tupleOfNullable(Class<T> type, @Nullable T... values)
<T> Tuple<@Nullable T>	tupleOfNullable(Class<T> type, Iterable<@Nullable T> iterable)
<T> Tuple<@Nullable T>	tupleOfNullable(Class<T> type, Maybe<@Nullable T>... maybes)
<T> Tuple<@Nullable T>	tupleOfNullable(Maybe<@Nullable T> first, Maybe<@Nullable T>... rest)
<T> Val<T>	valOf(Val<T> toBeCopied)
<T> Val<T>	valOf(T item)
<T> Val<@Nullable T>	valOfNull(Class<T> type)
<T> Val<@Nullable T>	valOfNullable(Class<T> type, @Nullable T item)
<T> Val<@Nullable T>	valOfNullable(Val<@Nullable T> toBeCopied)
<T> Vals<T>	valsOf(Class<T> type)
<T> Vals<T>	valsOf(Class<T> type, Iterable<Val<T>> properties)
<T> Vals<T>	valsOf(Class<T> type, Val<T>... vars)
<T> Vals<T>	valsOf(Class<T> type, Vals<T> vals)
<T> Vals<T>	valsOf(Class<T> type, T... items)
<T> Vals<T>	valsOf(Val<T> first, Val<T>... rest)
<T> Vals<T>	valsOf(T first, T... rest)
<T> Vals<@Nullable T>	valsOfNullable(Class<T> type)
<T> Vals<@Nullable T>	valsOfNullable(Class<T> type, @Nullable T... items)
<T> Vals<@Nullable T>	valsOfNullable(Class<T> type, Val<@Nullable T>... vals)
<T> Vals<@Nullable T>	valsOfNullable(Class<T> type, Vals<@Nullable T> vals)
<T> Vals<@Nullable T>	valsOfNullable(Val<@Nullable T> first, Val<@Nullable T>... rest)
<T, V extends T> Var<T>	varOf(Class<T> type, V item)
<T> Var<T>	varOf(T item)
<T> Var<T>	varOfNull(Class<T> type)
<T> Var<T>	varOfNullable(Class<T> type, @Nullable T item)
<T> Vars<T>	varsOf(Class<T> type)
<T> Vars<T>	varsOf(Class<T> type, Iterable<Var<T>> vars)
<T> Vars<T>	varsOf(Class<T> type, Var<T>... vars)
<T> Vars<T>	varsOf(Class<T> type, T... items)
<T> Vars<T>	varsOf(Var<T> first, Var<T>... rest)
<T> Vars<T>	varsOf(T first, T... rest)
<T> Vars<@Nullable T>	varsOfNullable(Class<T> type)
<T> Vars<@Nullable T>	varsOfNullable(Class<T> type, @Nullable T... values)
<T> Vars<T>	varsOfNullable(Class<T> type, Iterable<Var<T>> vars)
<T> Vars<@Nullable T>	varsOfNullable(Class<T> type, Var<@Nullable T>... vars)
<T> Vars<@Nullable T>	varsOfNullable(Var<@Nullable T> first, Var<@Nullable T>... rest)
<T extends @Nullable Object, U extends @Nullable Object, R> Viewable<R>	viewOf(Class<R> type, Val<T> first, Val<U> second, BiFunction<T,U,R> combiner)
<T, U> Viewable<T>	viewOf(Class<T> type, Val<U> source, Function<U,T> mapper)
<T> Viewable<T>	viewOf(Val<T> source)
<T extends @Nullable Object, U extends @Nullable Object> Viewable<@NonNull T>	viewOf(Val<T> first, Val<U> second, BiFunction<T,U,@NonNull T> combiner)
<T> Viewables<T>	viewOf(Vals<T> source)
<T, U> Viewable<U>	viewOf(U nullObject, U errorObject, Val<T> source, Function<T,@Nullable U> mapper)
<T, U> Viewables<U>	viewOf(U nullObject, U errorObject, Vals<T> source, Function<T,@Nullable U> mapper)
<T extends @Nullable Object, U extends @Nullable Object, R> Viewable<@Nullable R>	viewOfNullable(Class<R> type, Val<T> first, Val<U> second, BiFunction<T,U,@Nullable R> combiner)
<T, U> Viewable<@Nullable U>	viewOfNullable(Class<U> type, Val<T> source, Function<T,@Nullable U> mapper)
<T extends @Nullable Object, U extends @Nullable Object> Viewable<@Nullable T>	viewOfNullable(Val<T> first, Val<U> second, BiFunction<T,U,@Nullable T> combiner)

Methods inherited from class java.lang.Object

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

Methods inherited from interface sprouts.impl.SproutsFactory

maybeOf, maybeOf, maybeOfNull, maybeOfNullable, maybeOfNullable

Method Details

factory

public static SproutsFactory factory()

A SproutsFactory is used by the various factory methods of this API like Var.of(Object), Vals.of(Object, Object[]), Result.of(Object)... to create instances of these properties.
You can plug in your own factory implementation through the setFactory(SproutsFactory) method, where you can then serve your own implementations of the various property types in the Sprouts library.

Returns:

The default factory for creating instances of the various property types in the Sprouts library.

setFactory

public static void setFactory(SproutsFactory factory)

Sets the factory to be used by the various factory methods of this API like Var.of(Object), Vals.of(Object, Object[]), Result.of(Object)... to create instances of these properties.
You can use a custom SproutsFactory to instantiate and serve your own implementations of the various property types in the Sprouts library.

WARNING: This is a global + mutable state, so be careful when using it
as it will have global side effects on the various factory methods of this API.

Parameters:

factory - The factory to be used by the various factory methods of this API.

Throws:

NullPointerException - if the factory is null.

delegateOf

public <T> ValDelegate<T> delegateOf(Val<T> source,
 Channel channel,
 SingleChange change,
 @Nullable T newValue,
 @Nullable T oldValue)

Specified by:

delegateOf in interface SproutsFactory

delegateOf

public <T> ValsDelegate<T> delegateOf(Vals<T> source,
 SequenceChange changeType,
 int index,
 Vals<T> newValues,
 Vals<T> oldValues)

Specified by:

delegateOf in interface SproutsFactory

event

public Event event()

Specified by:

event in interface SproutsFactory

eventOf

public Event eventOf(Event.Executor executor)

Specified by:

eventOf in interface SproutsFactory

valOfNullable

public <T> Val<@Nullable T> valOfNullable(Class<T> type,
 @Nullable T item)

Specified by:

valOfNullable in interface SproutsFactory

valOfNull

public <T> Val<@Nullable T> valOfNull(Class<T> type)

Specified by:

valOfNull in interface SproutsFactory

valOf

public <T> Val<T> valOf(T item)

Specified by:

valOf in interface SproutsFactory

valOf

public <T> Val<T> valOf(Val<T> toBeCopied)

Specified by:

valOf in interface SproutsFactory

valOfNullable

public <T> Val<@Nullable T> valOfNullable(Val<@Nullable T> toBeCopied)

Specified by:

valOfNullable in interface SproutsFactory

viewOf

public <T> Viewable<T> viewOf(Val<T> source)

Specified by:

viewOf in interface SproutsFactory

viewOf

public <T extends @Nullable Object,
U extends @Nullable Object>
Viewable<@NonNull T> viewOf(Val<T> first,
 Val<U> second,
 BiFunction<T,U,@NonNull T> combiner)

Specified by:

viewOf in interface SproutsFactory

viewOfNullable

public <T extends @Nullable Object,
U extends @Nullable Object>
Viewable<@Nullable T> viewOfNullable(Val<T> first,
 Val<U> second,
 BiFunction<T,U,@Nullable T> combiner)

Specified by:

viewOfNullable in interface SproutsFactory

viewOf

public <T extends @Nullable Object,
U extends @Nullable Object,
R>
Viewable<R> viewOf(Class<R> type,
 Val<T> first,
 Val<U> second,
 BiFunction<T,U,R> combiner)

Specified by:

viewOf in interface SproutsFactory

viewOfNullable

public <T extends @Nullable Object,
U extends @Nullable Object,
R>
Viewable<@Nullable R> viewOfNullable(Class<R> type,
 Val<T> first,
 Val<U> second,
 BiFunction<T,U,@Nullable R> combiner)

Specified by:

viewOfNullable in interface SproutsFactory

viewOf

public <T> Viewables<T> viewOf(Vals<T> source)

Specified by:

viewOf in interface SproutsFactory

viewOf

public <T,
U> Viewable<T> viewOf(Class<T> type,
 Val<U> source,
 Function<U,T> mapper)

Specified by:

viewOf in interface SproutsFactory

viewOf

public <T,
U> Viewables<U> viewOf(U nullObject,
 U errorObject,
 Vals<T> source,
 Function<T,@Nullable U> mapper)

Specified by:

viewOf in interface SproutsFactory

viewOf

public <T,
U> Viewable<U> viewOf(U nullObject,
 U errorObject,
 Val<T> source,
 Function<T,@Nullable U> mapper)

Specified by:

viewOf in interface SproutsFactory

viewOfNullable

public <T,
U> Viewable<@Nullable U> viewOfNullable(Class<U> type,
 Val<T> source,
 Function<T,@Nullable U> mapper)

Specified by:

viewOfNullable in interface SproutsFactory

lensOf

public <T,
B> Var<B> lensOf(Var<T> source,
 Lens<T,B> lens)

Specified by:

lensOf in interface SproutsFactory

lensOf

public <T,
B> Var<B> lensOf(Var<T> source,
 B nullObject,
 Lens<T,B> lens)

Specified by:

lensOf in interface SproutsFactory

lensOfNullable

public <T,
B> Var<B> lensOfNullable(Class<B> type,
 Var<T> source,
 Lens<T,B> lens)

Specified by:

lensOfNullable in interface SproutsFactory

varOfNullable

public <T> Var<T> varOfNullable(Class<T> type,
 @Nullable T item)

Specified by:

varOfNullable in interface SproutsFactory

varOfNull

public <T> Var<T> varOfNull(Class<T> type)

Specified by:

varOfNull in interface SproutsFactory

varOf

public <T> Var<T> varOf(T item)

Specified by:

varOf in interface SproutsFactory

varOf

public <T,
V extends T> Var<T> varOf(Class<T> type,
 V item)

Specified by:

varOf in interface SproutsFactory

valsOf

public <T> Vals<T> valsOf(Class<T> type)

Specified by:

valsOf in interface SproutsFactory

valsOf

public <T> Vals<T> valsOf(Class<T> type,
 Val<T>... vars)

Specified by:

valsOf in interface SproutsFactory

valsOf

public <T> Vals<T> valsOf(Val<T> first,
 Val<T>... rest)

Specified by:

valsOf in interface SproutsFactory

valsOf

public <T> Vals<T> valsOf(T first,
 T... rest)

Specified by:

valsOf in interface SproutsFactory

valsOf

public <T> Vals<T> valsOf(Class<T> type,
 T... items)

Specified by:

valsOf in interface SproutsFactory

valsOf

public <T> Vals<T> valsOf(Class<T> type,
 Iterable<Val<T>> properties)

Specified by:

valsOf in interface SproutsFactory

valsOf

public <T> Vals<T> valsOf(Class<T> type,
 Vals<T> vals)

Specified by:

valsOf in interface SproutsFactory

valsOfNullable

public <T> Vals<@Nullable T> valsOfNullable(Class<T> type,
 Val<@Nullable T>... vals)

Specified by:

valsOfNullable in interface SproutsFactory

valsOfNullable

public <T> Vals<@Nullable T> valsOfNullable(Class<T> type)

Specified by:

valsOfNullable in interface SproutsFactory

valsOfNullable

public <T> Vals<@Nullable T> valsOfNullable(Class<T> type,
 @Nullable T... items)

Specified by:

valsOfNullable in interface SproutsFactory

valsOfNullable

public <T> Vals<@Nullable T> valsOfNullable(Val<@Nullable T> first,
 Val<@Nullable T>... rest)

Specified by:

valsOfNullable in interface SproutsFactory

valsOfNullable

public <T> Vals<@Nullable T> valsOfNullable(Class<T> type,
 Vals<@Nullable T> vals)

Specified by:

valsOfNullable in interface SproutsFactory

varsOfNullable

public <T> Vars<T> varsOfNullable(Class<T> type,
 Iterable<Var<T>> vars)

Specified by:

varsOfNullable in interface SproutsFactory

tupleOf

public <T> Tuple<T> tupleOf(Class<T> type,
 Maybe<T>... maybes)

Specified by:

tupleOf in interface SproutsFactory

tupleOf

public <T> Tuple<T> tupleOf(Class<T> type)

Specified by:

tupleOf in interface SproutsFactory

tupleOf

public <T> Tuple<T> tupleOf(Maybe<T> first,
 Maybe<T>... rest)

Specified by:

tupleOf in interface SproutsFactory

tupleOf

public <T> Tuple<T> tupleOf(T first,
 T... rest)

Specified by:

tupleOf in interface SproutsFactory

tupleOf

public <T> Tuple<T> tupleOf(Class<T> type,
 T... items)

Specified by:

tupleOf in interface SproutsFactory

tupleOf

public <T> Tuple<T> tupleOf(Class<T> type,
 Iterable<T> iterable)

Specified by:

tupleOf in interface SproutsFactory

tupleOfNullable

public <T> Tuple<@Nullable T> tupleOfNullable(Class<T> type,
 Maybe<@Nullable T>... maybes)

Specified by:

tupleOfNullable in interface SproutsFactory

tupleOfNullable

public <T> Tuple<@Nullable T> tupleOfNullable(Class<T> type)

Specified by:

tupleOfNullable in interface SproutsFactory

tupleOfNullable

public <T> Tuple<@Nullable T> tupleOfNullable(Class<T> type,
 @Nullable T... values)

Specified by:

tupleOfNullable in interface SproutsFactory

tupleOfNullable

public <T> Tuple<@Nullable T> tupleOfNullable(Maybe<@Nullable T> first,
 Maybe<@Nullable T>... rest)

Specified by:

tupleOfNullable in interface SproutsFactory

tupleOfNullable

public <T> Tuple<@Nullable T> tupleOfNullable(Class<T> type,
 Iterable<@Nullable T> iterable)

Specified by:

tupleOfNullable in interface SproutsFactory

associationOf

public <K,
V> Association<K,V> associationOf(Class<K> keyType,
 Class<V> valueType)

Specified by:

associationOf in interface SproutsFactory

varsOf

public <T> Vars<T> varsOf(Class<T> type,
 Var<T>... vars)

Specified by:

varsOf in interface SproutsFactory

varsOf

public <T> Vars<T> varsOf(Class<T> type)

Specified by:

varsOf in interface SproutsFactory

varsOf

public <T> Vars<T> varsOf(Var<T> first,
 Var<T>... rest)

Specified by:

varsOf in interface SproutsFactory

varsOf

public <T> Vars<T> varsOf(T first,
 T... rest)

Specified by:

varsOf in interface SproutsFactory

varsOf

public <T> Vars<T> varsOf(Class<T> type,
 T... items)

Specified by:

varsOf in interface SproutsFactory

varsOf

public <T> Vars<T> varsOf(Class<T> type,
 Iterable<Var<T>> vars)

Specified by:

varsOf in interface SproutsFactory

varsOfNullable

public <T> Vars<@Nullable T> varsOfNullable(Class<T> type,
 Var<@Nullable T>... vars)

Specified by:

varsOfNullable in interface SproutsFactory

varsOfNullable

public <T> Vars<@Nullable T> varsOfNullable(Class<T> type)

Specified by:

varsOfNullable in interface SproutsFactory

varsOfNullable

public <T> Vars<@Nullable T> varsOfNullable(Class<T> type,
 @Nullable T... values)

Specified by:

varsOfNullable in interface SproutsFactory

varsOfNullable

public <T> Vars<@Nullable T> varsOfNullable(Var<@Nullable T> first,
 Var<@Nullable T>... rest)

Specified by:

varsOfNullable in interface SproutsFactory

resultOf

public <V> Result<V> resultOf(Class<V> type)

Specified by:

resultOf in interface SproutsFactory

resultOf

public <V> Result<V> resultOf(V value)

Specified by:

resultOf in interface SproutsFactory

resultOf

public <V> Result<V> resultOf(Class<V> type,
 @Nullable V value)

Specified by:

resultOf in interface SproutsFactory

resultOf

public <V> Result<V> resultOf(V value,
 Iterable<Problem> problems)

Specified by:

resultOf in interface SproutsFactory

resultOf

public <V> Result<V> resultOf(Class<V> type,
 Iterable<Problem> problems)

Specified by:

resultOf in interface SproutsFactory

resultOf

public <V> Result<V> resultOf(Class<V> type,
 @Nullable V value,
 Iterable<Problem> problems)

Specified by:

resultOf in interface SproutsFactory

resultOf

public <V> Result<V> resultOf(Class<V> type,
 @Nullable V value,
 Problem problem)

Specified by:

resultOf in interface SproutsFactory

resultOf

public <V> Result<V> resultOf(Class<V> type,
 Problem problem)

Specified by:

resultOf in interface SproutsFactory

resultOfList

public <V> Result<List<V>> resultOfList(Class<V> type,
 Problem problem)

Specified by:

resultOfList in interface SproutsFactory

resultOfList

public <V> Result<List<V>> resultOfList(Class<V> type,
 List<V> list)

Specified by:

resultOfList in interface SproutsFactory

resultOfList

public <V> Result<List<V>> resultOfList(Class<V> type,
 List<V> list,
 Iterable<Problem> problems)

Specified by:

resultOfList in interface SproutsFactory

resultOfTry

public <V> Result<V> resultOfTry(Class<V> type,
 Supplier<V> supplier)

Specified by:

resultOfTry in interface SproutsFactory

actionOfWeak

public <O,
D> WeakAction<O,D> actionOfWeak(O owner,
 BiConsumer<O,D> action)

Specified by:

actionOfWeak in interface SproutsFactory

observerOfWeak

public <O> WeakObserver<O> observerOfWeak(O owner,
 Consumer<O> action)

Specified by:

observerOfWeak in interface SproutsFactory

defaultId

public String defaultId()

Description copied from interface: SproutsFactory

The default id for properties which do not have an id explicitly specified. The id of a property is used to identify it in the system or as part of a view model and convert it into other data formats like key/value based data stores.

Specified by:

defaultId in interface SproutsFactory

Returns:

The default id for properties which do not have an id explicitly specified. This must never return null and it is recommended to be a constant or cached object due to this method being called frequently.

idPattern

public Pattern idPattern()

Description copied from interface: SproutsFactory

The regex Pattern used to validate property ids. All ids must match this pattern.

Specified by:

idPattern in interface SproutsFactory

Returns:

The regex Pattern used to validate property ids. This must never return null and it is recommended to be a constant or cached object due to this method being called frequently.

defaultChannel

public Channel defaultChannel()

Description copied from interface: SproutsFactory

The default channel used for change events. This channel is used to give events a chanel when no channel is explicitly specified.

Specified by:

defaultChannel in interface SproutsFactory

Returns:

The default channel used for change events. This must never return null and it is recommended to be a constant or cached object due to this method being called frequently.

defaultObservableChannel

public Channel defaultObservableChannel()

Description copied from interface: SproutsFactory

The default channel used for Observable events, registered through the Observable.subscribe(Observer) method.

Specified by:

defaultObservableChannel in interface SproutsFactory

Returns:

The default channel used for change events. This must never return null and it is recommended to be a constant or cached object due to this method being called frequently.