org.codefx.libfx.nesting.property

Class NestedStringPropertyBuilder

java.lang.Object

org.codefx.libfx.nesting.property.NestedStringPropertyBuilder

public class NestedStringPropertyBuilder
extends Object

A builder for a NestedStringProperty which is bound to the innerObservable of a Nesting.

Method Summary

Modifier and Type	Method and Description
NestedStringProperty	build() Creates a new property instance.
static NestedStringPropertyBuilder	forNesting(Nesting<javafx.beans.property.StringProperty> nesting) Creates a new builder which uses the specified nesting.
protected Object	getBean()
protected org.codefx.libfx.nesting.property.InnerObservableMissingBehavior<T>	getInnerObservableMissingBehavior()
protected String	getName()
protected Nesting<O>	getNesting()
B	onInnerObservableMissingComputeValue(Supplier<T> valueSupplier) The property will change to the value computed by the specified supplier when the inner observable goes missing (see NestedProperty for details on this).
B	onInnerObservableMissingKeepValue() The property will keep its value when the inner observable goes missing (see NestedProperty for details on this).
B	onInnerObservableMissingSetDefaultValue() The property will change to the default value for the wrapped type when the inner observable goes missing (see NestedProperty for details on this).
B	onInnerObservableMissingSetValue(T value) The property will change to the specified value when the inner observable goes missing (see NestedProperty for details on this).
B	onUpdateWhenInnerObservableMissingAcceptValues() The property will accept new values when it is updated (e.g.
B	onUpdateWhenInnerObservableMissingThrowException() The property will throw an IllegalStateException when it is updated (e.g.
B	setBean(Object bean) Sets the property's bean.
B	setName(String name) Sets the property's name.

Methods inherited from class java.lang.Object

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

Method Detail

forNesting

public static NestedStringPropertyBuilder forNesting(Nesting<javafx.beans.property.StringProperty> nesting)

Creates a new builder which uses the specified nesting.

Parameters:

nesting - the nesting which will be used for all nested properties

Returns:

a new instance of NestedStringPropertyBuilder

build

public NestedStringProperty build()

Creates a new property instance. This method can be called arbitrarily often and each call returns a new instance.

Returns:

the new instance of P, i.e. an implementation of NestedProperty

setBean

public final B setBean(Object bean)

Sets the property's bean.

Parameters:

bean - the property's future bean

Returns:

this builder

setName

public B setName(String name)

Sets the property's name.

Parameters:

name - the property's future name

Returns:

this builder

onInnerObservableMissingKeepValue

public B onInnerObservableMissingKeepValue()

The property will keep its value when the inner observable goes missing (see NestedProperty for details on this).

This is the default behavior.

Returns:

this builder

onInnerObservableMissingSetDefaultValue

public B onInnerObservableMissingSetDefaultValue()

The property will change to the default value for the wrapped type when the inner observable goes missing (see NestedProperty for details on this).

For primitive wrapping properties (e.g. NestedIntegerProperty), this will set the primitive default (e.g. 0); for reference wrapping properties this will be null.

Returns:

this builder

onInnerObservableMissingSetValue

public B onInnerObservableMissingSetValue(T value)

The property will change to the specified value when the inner observable goes missing (see NestedProperty for details on this).

This method does not accept null as a value. Call onInnerObservableMissingSetDefaultValue() if the property should change to the default value for the wrapped type (e.g. 0 for NestedIntegerProperty).

Parameters:

value - the value to set

Returns:

this builder

onInnerObservableMissingComputeValue

public B onInnerObservableMissingComputeValue(Supplier<T> valueSupplier)

The property will change to the value computed by the specified supplier when the inner observable goes missing (see NestedProperty for details on this).

The supplier may produce null in which case primitive wrapping properties will fall back to the type's default value (e.g. 0 for NestedIntegerProperty).

Parameters:

valueSupplier - the supplier which computes the value to set; may produce null

Returns:

this builder

onUpdateWhenInnerObservableMissingThrowException

public B onUpdateWhenInnerObservableMissingThrowException()

The property will throw an IllegalStateException when it is updated (e.g. by calling setValue or via a binding) while the inner observable is missing (see NestedProperty for details on this).

This is the default behavior.

Returns:

this builder

onUpdateWhenInnerObservableMissingAcceptValues

public B onUpdateWhenInnerObservableMissingAcceptValues()

The property will accept new values when it is updated (e.g. by calling setValue or via a binding) while the inner observable is missing (see NestedProperty for details on this).

Once the nesting changes to a new (non-missing) inner observable, the property will change to that observable's value.

Returns:

this builder

getNesting

protected final Nesting<O> getNesting()

Returns:

the nesting which will be used for all nested properties

getBean

protected final Object getBean()

Returns:

the property's bean.

getName

protected final String getName()

Returns:

the property's bean.

getInnerObservableMissingBehavior

protected final org.codefx.libfx.nesting.property.InnerObservableMissingBehavior<T> getInnerObservableMissingBehavior()

Returns:

the property's behavior for the case that the inner observable is missing