javafixes.object.changing

Interface ChangingValue<T>

Type Parameters:

T - type of wrapped value

All Superinterfaces:

Value<T>

All Known Implementing Classes:

DerivedValue, DynamicValue, MutableValue

public interface ChangingValue<T>
extends Value<T>

ChangingValue is intended as wrapper of value that could change over time and whose changes should propagate to other values automatically.

A good usage example would be a config from which other values could be derived and should be changed once config changes.

Method Summary

Modifier and Type	Method and Description
long	changeVersion() Indicator of how often has the wrapped value changed.
default <E extends java.lang.Throwable> void	forCurrentValue(ValueHandler<? super T,? extends E> valueHandler) Executes valueHandler function for currently wrapped value
static <T1,T2> DerivedValue<Tuple<T1,T2>,?>	join(ChangingValue<T1> value1, ChangingValue<T2> value2) Merges two ChangingValues of type T1 and T2 into one DerivedValue of type Tuple<T1, T2>
static <T1,T2,T3> DerivedValue<Triple<T1,T2,T3>,?>	join(ChangingValue<T1> value1, ChangingValue<T2> value2, ChangingValue<T3> value3) Merges three ChangingValues of type T1, T2 and T3 into one DerivedValue of type Triple<T1, T2, T3>
static <T> ChangingValue<java.util.List<T>>	join(java.util.List<ChangingValue<T>> values) Merges a List of ChangingValues of type T into one ChangingValue of type List<T>
default <T2> DerivedValue<T2,T>	map(java.util.function.Function<T,? extends T2> derivedValueMapper) Creates a new DerivedValue from this ChangingValue.
default <T2,E extends java.lang.Throwable> T2	mapToValue(ValueMapper<? super T,? extends T2,E> valueMapper) Generates a value using the current ChangingValue's wrapped value
java.util.Optional<java.lang.String>	name()

Methods inherited from interface javafixes.object.Value

getValue, value

Method Detail

name

java.util.Optional<java.lang.String> name()

Returns:

optional name of ChangingValue

changeVersion

long changeVersion()

Indicator of how often has the wrapped value changed. Should be 0 when value is created and each time the underlying value changes the changeVersion should increase by one.

Returns:

number indicator of how many times has the wrapped value changed

map

default <T2> DerivedValue<T2,T> map(java.util.function.Function<T,? extends T2> derivedValueMapper)

Creates a new DerivedValue from this ChangingValue. Each time the generated DerivedValue will be used and this value will change, the DerivedValue will regenerate it's value using the provided derivedValueMapper

Type Parameters:

T2 - type of newly generated DerivedValue

Parameters:

derivedValueMapper - function that is applied to this ChangingValue's wrapped value to generate new DerivedValue's value

Returns:

generated DerivedValue

mapToValue

default <T2,E extends java.lang.Throwable> T2 mapToValue(ValueMapper<? super T,? extends T2,E> valueMapper)
                                                  throws E extends java.lang.Throwable

Generates a value using the current ChangingValue's wrapped value

Type Parameters:

T2 - type of generated value

E - Throwable type, in case the valueMapper function should throw an Throwable

Parameters:

valueMapper - function that is applied to currently wrapped value

Returns:

generated value

Throws:

E - exception generated by valueMapper function

E extends java.lang.Throwable

forCurrentValue

default <E extends java.lang.Throwable> void forCurrentValue(ValueHandler<? super T,? extends E> valueHandler)
                                                      throws E extends java.lang.Throwable

Executes valueHandler function for currently wrapped value

Type Parameters:

E - Throwable type, in case the valueHandler function should throw an Throwable

Parameters:

valueHandler - function that is executed for currently wrapped value

Throws:

E - exception generated by valueHandler function

E extends java.lang.Throwable

join

static <T1,T2> DerivedValue<Tuple<T1,T2>,?> join(ChangingValue<T1> value1,
                                                 ChangingValue<T2> value2)

Merges two ChangingValues of type T1 and T2 into one DerivedValue of type Tuple<T1, T2>

Type Parameters:

T1 - type of value1

T2 - type of value2

Parameters:

value1 - first ChangingValue of type T1

value2 - second ChangingValue of type T2

Returns:

DerivedValue of type Tuple<T1, T2>

join

static <T1,T2,T3> DerivedValue<Triple<T1,T2,T3>,?> join(ChangingValue<T1> value1,
                                                        ChangingValue<T2> value2,
                                                        ChangingValue<T3> value3)

Merges three ChangingValues of type T1, T2 and T3 into one DerivedValue of type Triple<T1, T2, T3>

Type Parameters:

T1 - type of value1

T2 - type of value2

T3 - type of value3

Parameters:

value1 - first ChangingValue of type T1

value2 - second ChangingValue of type T2

value3 - third ChangingValue of type T3

Returns:

DerivedValue of type Triple<T1, T2, T3>

join

static <T> ChangingValue<java.util.List<T>> join(java.util.List<ChangingValue<T>> values)

Merges a List of ChangingValues of type T into one ChangingValue of type List<T>

Type Parameters:

T - type of values List

Parameters:

values - changing values to merge

Returns:

ChangingValue of type List<T>