org.codefx.libfx.nesting

Class Nestings

java.lang.Object

org.codefx.libfx.nesting.Nestings

public class Nestings
extends Object

This class provides static functions to obtain builders for nested classes like Nesting or NestedProperty.

Builders

Calling on will return a builder whose type depends on the type of the specified observable. Similarly a call to one of the builders' nest...-methods returns a (new) builder whose type depends on the type of observable the nesting step will return. Each type of builder allows only those functions which are supported by that observable.

Examples on Builder Types

If the last nesting step provides a DoubleProperty, a DoublePropertyNestingBuilder will be returned. Because a Double cannot contain another observable no further nesting is possible and hence no nest...-methods are available. But it can be used to build a NestedDoubleProperty which in turn is not possible e.g. on an ObservableValue and is hence not provided by an ObservableValueNestingBuilder.

Likewise a ChangeListener cannot be added if the last step provides an Observable because it only accepts InvalidationListeners.

Examples

More examples and explanations can be found online.

Change Listener

 
 Nestings.on(currentEmployee)
 	.nestProperty(employee -> employee.addressProperty())
 	.nestProperty(address -> address.streetNameProperty())
 	.addListener((observable, oldValue, newValue) -> ... );
 
 

Nested Property

 
 NestedStringProperty asNestedStringProperty = Nestings.on(currentEmployee)
 	.nestProperty(employee -> employee.addressProperty())
 	.nestStringProperty(address -> address.streetNameProperty())
 	.buildProperty();
 
 

See Also:

Nesting, NestedProperty, NestedChangeListenerHandle, NestedInvalidationListenerHandle

Constructor Summary

Constructors

Constructor and Description
Nestings()

Method Summary

Modifier and Type	Method and Description
static ObservableNestingBuilder	on(javafx.beans.Observable outerObservable) Starts a nesting with the specified outer observable.
static <T> ObservableValueNestingBuilder<T>	on(javafx.beans.value.ObservableValue<T> outerObservable) Starts a nesting with the specified outer observable.
static <T> ObjectPropertyNestingBuilder<T>	on(javafx.beans.property.Property<T> outerProperty) Starts a nesting with the specified outer property.

Methods inherited from class java.lang.Object

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

Constructor Detail

Nestings

public Nestings()

Method Detail

on

public static ObservableNestingBuilder on(javafx.beans.Observable outerObservable)

Starts a nesting with the specified outer observable.

Parameters:

outerObservable - the outer Observable on which the nesting begins

Returns:

an instance of ObservableNestingBuilder which depends on the specified outer observable

on

public static <T> ObservableValueNestingBuilder<T> on(javafx.beans.value.ObservableValue<T> outerObservable)

Starts a nesting with the specified outer observable.

Type Parameters:

T - the type the outer observable wraps

Parameters:

outerObservable - the outer ObservableValue on which the nesting begins

Returns:

an instance of ObservableValueNestingBuilder which depends on the specified outer observable

on

public static <T> ObjectPropertyNestingBuilder<T> on(javafx.beans.property.Property<T> outerProperty)

Starts a nesting with the specified outer property.

Type Parameters:

T - the type the outer property wraps

Parameters:

outerProperty - the outer Property on which the nesting begins

Returns:

an instance of ObjectPropertyNestingBuilder which depends on the specified outer observable value