javafixes.object.changing

Class MutableValue<T>

java.lang.Object

javafixes.object.changing.MutableValue<T>

Type Parameters:

T - type of wrapped value

All Implemented Interfaces:

ChangingValue<T>, Value<T>

public class MutableValue<T>
extends java.lang.Object
implements ChangingValue<T>

MutableValue is a wrapper of value that you can replace and whose changes will be propagated to derived values.

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.
static <T> MutableValue<T>	failedMutableValue(java.lang.RuntimeException exception) Factory method for MutableValue
static <T> MutableValue<T>	mutableValue(T initialValue) Factory method for MutableValue
java.util.Optional<java.lang.String>	name()
void	updateAsFailure(java.lang.RuntimeException exception) Updates wrapped value as an exception and increments the changeVersion
void	updateValue(T newValue) Updates wrapped value and increments the changeVersion
boolean	updateValueIfDifferent(T potentialNewValue) If potentialNewValue is different than the already wrapped, it then value will replace the old one and the changeVersion will be incremented.
T	value()
MutableValue<T>	withDisposeFunction(java.util.function.Consumer<T> disposeFunction) Creates a copy of current MutableValue with defined dispose function
MutableValue<T>	withDisposeFunction(java.util.Optional<java.util.function.Consumer<T>> optionalDisposeFunction) Creates a copy of current MutableValue with new dispose function if Optional dispose function is defined and without a dispose function if the Optional dispose function is undefined
MutableValue<T>	withNoDisposeFunction() Creates a copy of current MutableValue with dispose function being removed
MutableValue<T>	withNoOnValueSetFunction() Creates a copy of current MutableValue with on value set function being removed
MutableValue<T>	withNoValueName() Creates a copy of current MutableValue with value name being removed
MutableValue<T>	withOnValueSetFunction(java.util.function.Consumer<T> onValueSetFunction, boolean applyToCurrentValue) Creates a copy of current MutableValue with defined function applied to each new wrapped value
MutableValue<T>	withOnValueSetFunction(java.util.Optional<java.util.function.Consumer<T>> optionalOnValueSetFunction, boolean applyToCurrentValue) Creates a copy of current MutableValue with new on value set function if Optional on value set function is defined and without an on value set function if the Optional on value set function is undefined
MutableValue<T>	withValueName(java.util.Optional<java.lang.String> optionalValueName) Creates a copy of current MutableValue with new value name if Optional name is defined and without a value name if the Optional name is undefined
MutableValue<T>	withValueName(java.lang.String valueName) Creates a copy of current MutableValue with defined value name

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafixes.object.changing.ChangingValue

forCurrentValue, join, join, join, map, mapToValue

Methods inherited from interface javafixes.object.Value

getValue

Method Detail

mutableValue

public static <T> MutableValue<T> mutableValue(T initialValue)

Factory method for MutableValue

Type Parameters:

T - type of wrapped value

Parameters:

initialValue - initial value

Returns:

MutableValue value

failedMutableValue

public static <T> MutableValue<T> failedMutableValue(java.lang.RuntimeException exception)

Factory method for MutableValue

Type Parameters:

T - type of wrapped value

Parameters:

exception - RuntimeException caught when trying to get initial value

Returns:

MutableValue value

withValueName

public MutableValue<T> withValueName(java.lang.String valueName)

Creates a copy of current MutableValue with defined value name

Parameters:

valueName - new value name to use

Returns:

copy of current MutableValue with a new value name

withNoValueName

public MutableValue<T> withNoValueName()

Creates a copy of current MutableValue with value name being removed

Returns:

copy of current MutableValue without a value name

withValueName

public MutableValue<T> withValueName(java.util.Optional<java.lang.String> optionalValueName)

Creates a copy of current MutableValue with new value name if Optional name is defined and without a value name if the Optional name is undefined

Parameters:

optionalValueName - if empty new MutableValue will have no value name otherwise the define value name will be used

Returns:

copy of current MutableValue with defined value name

withOnValueSetFunction

public MutableValue<T> withOnValueSetFunction(java.util.function.Consumer<T> onValueSetFunction,
                                              boolean applyToCurrentValue)

Creates a copy of current MutableValue with defined function applied to each new wrapped value

Parameters:

onValueSetFunction - function that is called using new value when it is being passed in

applyToCurrentValue - indicator if the onValueSetFunction should be applied to the currently wrapped value

Returns:

copy of current MutableValue with a new on value set function

withNoOnValueSetFunction

public MutableValue<T> withNoOnValueSetFunction()

Creates a copy of current MutableValue with on value set function being removed

Returns:

copy of current MutableValue without an on value set function

withOnValueSetFunction

public MutableValue<T> withOnValueSetFunction(java.util.Optional<java.util.function.Consumer<T>> optionalOnValueSetFunction,
                                              boolean applyToCurrentValue)

Creates a copy of current MutableValue with new on value set function if Optional on value set function is defined and without an on value set function if the Optional on value set function is undefined

Parameters:

optionalOnValueSetFunction - if empty new MutableValue will have no on value set function otherwise the define on value set function will be used

applyToCurrentValue - indicator if the defined optionalOnValueSetFunction should be applied to the currently wrapped value

Returns:

copy of current MutableValue with defined on value set function

withDisposeFunction

public MutableValue<T> withDisposeFunction(java.util.function.Consumer<T> disposeFunction)

Creates a copy of current MutableValue with defined dispose function

Parameters:

disposeFunction - function that is called using old value when a new value is being passed in

Returns:

copy of current MutableValue with a new dispose function

withNoDisposeFunction

public MutableValue<T> withNoDisposeFunction()

Creates a copy of current MutableValue with dispose function being removed

Returns:

copy of current MutableValue without a dispose function

withDisposeFunction

public MutableValue<T> withDisposeFunction(java.util.Optional<java.util.function.Consumer<T>> optionalDisposeFunction)

Creates a copy of current MutableValue with new dispose function if Optional dispose function is defined and without a dispose function if the Optional dispose function is undefined

Parameters:

optionalDisposeFunction - if empty new MutableValue will have no dispose function otherwise the define dispose function will be used

Returns:

copy of current MutableValue with defined dispose function

name

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

Specified by:

name in interface ChangingValue<T>

Returns:

optional name of ChangingValue

updateValue

public void updateValue(T newValue)

Updates wrapped value and increments the changeVersion

Parameters:

newValue - new value that will be wrapped

updateValueIfDifferent

public boolean updateValueIfDifferent(T potentialNewValue)

If potentialNewValue is different than the already wrapped, it then value will replace the old one and the changeVersion will be incremented. If they will be the same then no change will happen

Parameters:

potentialNewValue - value that might be wrapped if it is different than the already wrapped

Returns:

if the wrapped value has been changed

updateAsFailure

public void updateAsFailure(java.lang.RuntimeException exception)

Updates wrapped value as an exception and increments the changeVersion

Parameters:

exception - new value that will be wrapped

value

public T value()

Specified by:

value in interface Value<T>

changeVersion

public long changeVersion()

Description copied from interface: ChangingValue

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.

Specified by:

changeVersion in interface ChangingValue<T>

Returns:

number indicator of how many times has the wrapped value changed