de.saxsys.bindablefx

Interface IFluentBinding<TValue>

All Superinterfaces:

javafx.beans.binding.Binding<TValue>, javafx.beans.Observable, javafx.beans.value.ObservableValue<TValue>, javafx.beans.WeakListener

All Known Subinterfaces:

IPropertyBinding<TValue>

All Known Implementing Classes:

RelayBinding

public interface IFluentBinding<TValue>
extends javafx.beans.binding.Binding<TValue>, javafx.beans.WeakListener

This interface allows for fluent api calls when binding ObservableValue or Property.

Author:

Xyanid on 29.07.2016.

Method Summary

Modifier and Type	Method and Description
default <TConvertedValue> @NotNull IFluentBinding<TConvertedValue>	convertTo(@NotNull Function<TValue,TConvertedValue> converter) Creates a new IFluentBinding that converts the value of this IFluentBinding into another type.
@NotNull IFluentBinding<TValue>	fallbackOn(TValue fallbackValue) Sets a fallback value that will be returned if the underlying ObservableValue is not yet set.
boolean	hasFallbackValue() Determines if the binding has as fallback value.
boolean	hasListeners() Determines if this binding has any ChangeListener or InvalidationListener attached to it.
boolean	hasReplacement() Determines if the binding has a replacement.
@NotNull IFluentBinding<TValue>	replaceWith(@Nullable Function<TValue,TValue> valueReplacer) Applies the given Function whenever the underlying ObservableValue is changed, allowing for certain values to be replaced or ignored.
default @NotNull IFluentBinding<TValue>	replaceWith(@NotNull Predicate<TValue> fallbackTriggerValue, TValue fallbackValue) Fallback on the given fallback value if the value of the underlying ObservableValue computes to true using the given Predicate.
@NotNull IFluentBinding<TValue>	stopFallbackOn() Removes the fallback value, so that null will be returned instead of the fallback value.
@NotNull IFluentBinding<TValue>	stopListeners() Removes all the ChangeListener and InvalidationListener that have been attached to this binding.
@NotNull IFluentBinding<TValue>	stopReplacement() Stops replacing the value of the underlying ObservableValue.
default <TRelayedValue,TRelayedObservedValue extends javafx.beans.value.ObservableValue<TRelayedValue>> @NotNull IFluentBinding<TRelayedValue>	thenObserve(@NotNull Function<TValue,TRelayedObservedValue> relayResolver) Creates a new IFluentBinding that listens to changes of this IFluentBinding and then relays to another ObservableValue that is being watched.
default <TRelayedValue,TRelayedProperty extends javafx.beans.property.Property<TRelayedValue>> @NotNull IPropertyBinding<TRelayedValue>	thenObserveProperty(@NotNull Function<TValue,TRelayedProperty> relayResolver) Creates a new IFluentBinding that listens to changes of this IFluentBinding and then relays to another Property that is being watched.

Methods inherited from interface javafx.beans.binding.Binding

dispose, getDependencies, invalidate, isValid

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface javafx.beans.WeakListener

wasGarbageCollected

Method Detail

fallbackOn

@NotNull
@NotNull IFluentBinding<TValue> fallbackOn(@Nullable
                                                     TValue fallbackValue)

Sets a fallback value that will be returned if the underlying ObservableValue is not yet set.

Parameters:

fallbackValue - the value to fallback on.

Returns:

this IFluentBinding.

See Also:

stopFallbackOn(), hasFallbackValue()

stopFallbackOn

@NotNull
@NotNull IFluentBinding<TValue> stopFallbackOn()

Removes the fallback value, so that null will be returned instead of the fallback value.

Returns:

this IFluentBinding.

See Also:

fallbackOn(Object), hasFallbackValue()

hasFallbackValue

boolean hasFallbackValue()

Determines if the binding has as fallback value.

Returns:

true if the binding has a fallback value, otherwise false.

See Also:

fallbackOn(Object), stopFallbackOn()

replaceWith

@NotNull
default @NotNull IFluentBinding<TValue> replaceWith(@NotNull
                                                              @NotNull Predicate<TValue> fallbackTriggerValue,
                                                              @Nullable
                                                              TValue fallbackValue)

Fallback on the given fallback value if the value of the underlying ObservableValue computes to true using the given Predicate.

Parameters:

fallbackTriggerValue - determine when the value of the underlying ObservableValue will be replaced with the given fallback value.

fallbackValue - the value to fallback on.

Returns:

this IFluentBinding.

See Also:

replaceWith(Function), stopReplacement(), hasReplacement()

replaceWith

@NotNull
@NotNull IFluentBinding<TValue> replaceWith(@Nullable
                                                      @Nullable Function<TValue,TValue> valueReplacer)

Applies the given Function whenever the underlying ObservableValue is changed, allowing for certain values to be replaced or ignored. In order to stop this behaviour a call to stopReplacement() is required. A call to this method should overwrite previous call, so only the last applied behaviour is used.

Parameters:

valueReplacer - the Function which decided if the value of the underlying ObservableValue will be replaced with the fallback value.

Returns:

this IFluentBinding.

See Also:

replaceWith(Predicate, Object), stopReplacement(), stopReplacement(), hasReplacement()

stopReplacement

@NotNull
@NotNull IFluentBinding<TValue> stopReplacement()

Stops replacing the value of the underlying ObservableValue.

Returns:

this IFluentBinding.

See Also:

replaceWith(Function), replaceWith(Predicate, Object), hasReplacement()

hasReplacement

boolean hasReplacement()

Determines if the binding has a replacement.

Returns:

true if the binding has a replacement, otherwise false.

See Also:

replaceWith(Predicate, Object), replaceWith(Function), stopReplacement()

stopListeners

@NotNull
@NotNull IFluentBinding<TValue> stopListeners()

Removes all the ChangeListener and InvalidationListener that have been attached to this binding.

Returns:

this IFluentBinding.

See Also:

ObservableValue.addListener(ChangeListener), Observable.addListener(InvalidationListener), hasListeners()

hasListeners

boolean hasListeners()

Determines if this binding has any ChangeListener or InvalidationListener attached to it.

Returns:

true if the binding has any ChangeListener or InvalidationListener attached to it, otherwise false.

See Also:

stopListeners(), ObservableValue.addListener(ChangeListener), Observable.addListener(InvalidationListener)

convertTo

@NotNull
default <TConvertedValue> @NotNull IFluentBinding<TConvertedValue> convertTo(@NotNull
                                                                                       @NotNull Function<TValue,TConvertedValue> converter)

Creates a new IFluentBinding that converts the value of this IFluentBinding into another type.

Type Parameters:

TConvertedValue - the desired type to convert into.

Parameters:

converter - the Function to use when converting form the type of this IFluentBinding into the desired type.

Returns:

a new IFluentBinding which listens to changes of this IFluentBinding.

See Also:

ConverterBinding

thenObserve

@NotNull
default <TRelayedValue,TRelayedObservedValue extends javafx.beans.value.ObservableValue<TRelayedValue>> @NotNull IFluentBinding<TRelayedValue> thenObserve(@NotNull
                                                                                                                                                                     @NotNull Function<TValue,TRelayedObservedValue> relayResolver)

Creates a new IFluentBinding that listens to changes of this IFluentBinding and then relays to another ObservableValue that is being watched.

Type Parameters:

TRelayedValue - the type of value of the relayed ObservableValue.

TRelayedObservedValue - the type of the ObservableValue.

Parameters:

relayResolver - the Function that is used to determine the new ObservableValue that is to be watched by the newly created IFluentBinding.

Returns:

a new IFluentBinding.

See Also:

RelayBinding

thenObserveProperty

@NotNull
default <TRelayedValue,TRelayedProperty extends javafx.beans.property.Property<TRelayedValue>> @NotNull IPropertyBinding<TRelayedValue> thenObserveProperty(@NotNull
                                                                                                                                                                      @NotNull Function<TValue,TRelayedProperty> relayResolver)

Creates a new IFluentBinding that listens to changes of this IFluentBinding and then relays to another Property that is being watched.

Type Parameters:

TRelayedValue - the type of value of the relayed Property.

TRelayedProperty - the type of the Property.

Parameters:

relayResolver - the Function that is used to determine the new Property that is to be watched by the newly created IFluentBinding.

Returns:

a new IFluentBinding.

See Also:

PropertyBinding