ObjectPropertyNestingBuilder (LibFX 0.3.0 API)

java.lang.Object
- org.codefx.libfx.nesting.ObjectPropertyNestingBuilder<T>

Type Parameters:

T - the type of the value wrapped by the Property
```
public class ObjectPropertyNestingBuilder<T>
extends Object
```
A builder for all kinds of nested functionality whose inner observable is a Property.
Because the wrapped value might contain properties of its own, nesting is possible (e.g. with nest).

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

NestedObjectProperty<T> build
Creates a nested property from this builder's settings.

All Methods Instance Methods Concrete Methods
Type	Property and Description
`NestedObjectProperty<T>`	`build` Creates a nested property from this builder's settings.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractNestingBuilderOnObservable.NestingConstructionKit` An editable class which can be used to collect all instances needed to call `new Nesting(...)`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NestedChangeListenerHandle<T>`	`addListener(javafx.beans.value.ChangeListener<? super T> listener)` Adds the specified change listener to the nesting hierarchy's inner `ObservableValue`.
`NestedInvalidationListenerHandle`	`addListener(javafx.beans.InvalidationListener listener)` Adds the specified invalidation listener to the nesting hierarchy's inner `Observable`.
`Nesting<O>`	`buildNesting()` Creates a new nesting from this builder's settings.
`NestedObjectProperty<T>`	`buildProperty()` Creates a nested property from this builder's settings.
`NestedObjectPropertyBuilder<T>`	`buildPropertyWithBuilder()` Returns a nested object property builder which can be used to define the new property's attributes before building it.
`<N> ObjectPropertyNestingBuilder<N>`	`nest(NestingStep<T,javafx.beans.property.Property<N>> nestingStep)` Usability method which simply calls `nestProperty`.
`BooleanPropertyNestingBuilder`	`nestBooleanProperty(NestingStep<T,javafx.beans.property.BooleanProperty> nestingStep)` Returns a builder for nestings whose inner observable is a `BooleanProperty`.
`DoublePropertyNestingBuilder`	`nestDoubleProperty(NestingStep<T,javafx.beans.property.DoubleProperty> nestingStep)` Returns a builder for nestings whose inner observable is a `DoubleProperty`.
`FloatPropertyNestingBuilder`	`nestFloatProperty(NestingStep<T,javafx.beans.property.FloatProperty> nestingStep)` Returns a builder for nestings whose inner observable is a `FloatProperty`.
`IntegerPropertyNestingBuilder`	`nestIntegerProperty(NestingStep<T,javafx.beans.property.IntegerProperty> nestingStep)` Returns a builder for nestings whose inner observable is an `IntegerProperty`.
`LongPropertyNestingBuilder`	`nestLongProperty(NestingStep<T,javafx.beans.property.LongProperty> nestingStep)` Returns a builder for nestings whose inner observable is a `LongProperty`.
`ObservableNestingBuilder`	`nestObservable(NestingStep<T,javafx.beans.Observable> nestingStep)` Returns a builder for nestings whose inner observable is an `Observable`.
`<N> ObservableNumberValueNestingBuilder`	`nestObservableNumberValue(NestingStep<T,javafx.beans.value.ObservableNumberValue> nestingStep)` Returns a builder for nestings whose inner observable is an `ObservableNumberValue`.
`<N> ObservableValueNestingBuilder<N>`	`nestObservableValue(NestingStep<T,javafx.beans.value.ObservableValue<N>> nestingStep)` Returns a builder for nestings whose inner observable is an `ObservableValue`.
`<N> ObjectPropertyNestingBuilder<N>`	`nestProperty(NestingStep<T,javafx.beans.property.Property<N>> nestingStep)` Returns a builder for nestings whose inner observable is a `Property`.
`StringPropertyNestingBuilder`	`nestStringProperty(NestingStep<T,javafx.beans.property.StringProperty> nestingStep)` Returns a builder for nestings whose inner observable is a `StringProperty`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - build
```
public NestedObjectProperty<T> buildProperty
```
    Creates a nested property from this builder's settings. This method can be called arbitrarily often and each call returns a new instance.
- Method Detail
  - nestObservable
```
public ObservableNestingBuilder nestObservable(NestingStep<T,javafx.beans.Observable> nestingStep)
```
    Returns a builder for nestings whose inner observable is an Observable. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    an ObservableNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
  - nestObservableValue
```
public <N> ObservableValueNestingBuilder<N> nestObservableValue(NestingStep<T,javafx.beans.value.ObservableValue<N>> nestingStep)
```
    Returns a builder for nestings whose inner observable is an ObservableValue. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Type Parameters:
    
    N - the type wrapped by the created nesting builder
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    an ObservableValueNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
  - nestObservableNumberValue
```
public <N> ObservableNumberValueNestingBuilder nestObservableNumberValue(NestingStep<T,javafx.beans.value.ObservableNumberValue> nestingStep)
```
    Returns a builder for nestings whose inner observable is an ObservableNumberValue. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Type Parameters:
    
    N - the type wrapped by the created nesting builder
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    an ObservableNumberValueNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
  - nestProperty
```
public <N> ObjectPropertyNestingBuilder<N> nestProperty(NestingStep<T,javafx.beans.property.Property<N>> nestingStep)
```
    Returns a builder for nestings whose inner observable is a Property. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Type Parameters:
    
    N - the type wrapped by the created nesting builder
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    an ObjectPropertyNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
  - nest
```
public <N> ObjectPropertyNestingBuilder<N> nest(NestingStep<T,javafx.beans.property.Property<N>> nestingStep)
```
    Usability method which simply calls nestProperty.
    Returns a builder for nestings whose inner observable is a Property. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Type Parameters:
    
    N - the type wrapped by the created nesting builder
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    an ObservableValueNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
    
    Throws:
    
    NullPointerException - if the specified function is null
  - nestBooleanProperty
```
public BooleanPropertyNestingBuilder nestBooleanProperty(NestingStep<T,javafx.beans.property.BooleanProperty> nestingStep)
```
    Returns a builder for nestings whose inner observable is a BooleanProperty. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    a BooleanPropertyNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
    
    Throws:
    
    NullPointerException - if the specified function is null
  - nestIntegerProperty
```
public IntegerPropertyNestingBuilder nestIntegerProperty(NestingStep<T,javafx.beans.property.IntegerProperty> nestingStep)
```
    Returns a builder for nestings whose inner observable is an IntegerProperty. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    an IntegerPropertyNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
    
    Throws:
    
    NullPointerException - if the specified function is null
  - nestLongProperty
```
public LongPropertyNestingBuilder nestLongProperty(NestingStep<T,javafx.beans.property.LongProperty> nestingStep)
```
    Returns a builder for nestings whose inner observable is a LongProperty. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    a LongPropertyNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
    
    Throws:
    
    NullPointerException - if the specified function is null
  - nestFloatProperty
```
public FloatPropertyNestingBuilder nestFloatProperty(NestingStep<T,javafx.beans.property.FloatProperty> nestingStep)
```
    Returns a builder for nestings whose inner observable is a FloatProperty. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    a FloatPropertyNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
    
    Throws:
    
    NullPointerException - if the specified function is null
  - nestDoubleProperty
```
public DoublePropertyNestingBuilder nestDoubleProperty(NestingStep<T,javafx.beans.property.DoubleProperty> nestingStep)
```
    Returns a builder for nestings whose inner observable is a DoubleProperty. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    a DoublePropertyNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
    
    Throws:
    
    NullPointerException - if the specified function is null
  - nestStringProperty
```
public StringPropertyNestingBuilder nestStringProperty(NestingStep<T,javafx.beans.property.StringProperty> nestingStep)
```
    Returns a builder for nestings whose inner observable is a StringProperty. The created nestings depend on this builder's outer observable and nesting steps and adds the specified step as the next one.
    
    Parameters:
    
    nestingStep - the function which performs the nesting step from one observable to the next
    
    Returns:
    
    a StringPropertyNestingBuilder which builds a nesting from this builder's settings and the specified nesting steps
    
    Throws:
    
    NullPointerException - if the specified function is null
  - buildProperty
```
public NestedObjectProperty<T> buildProperty()
```
    Creates a nested property from this builder's settings. This method can be called arbitrarily often and each call returns a new instance.
  - buildPropertyWithBuilder
```
public NestedObjectPropertyBuilder<T> buildPropertyWithBuilder()
```
    Returns a nested object property builder which can be used to define the new property's attributes before building it.
    
    Returns:
    
    a new instance of NestedObjectPropertyBuilder
  - addListener
```
public NestedChangeListenerHandle<T> addListener(javafx.beans.value.ChangeListener<? super T> listener)
```
    Adds the specified change listener to the nesting hierarchy's inner ObservableValue.
    
    Parameters:
    
    listener - the added ChangeListener
    
    Returns:
    
    the NestedChangeListenerHandle which can be used to check the nesting's state
  - buildNesting
```
public Nesting<O> buildNesting()
```
    Creates a new nesting from this builder's settings. This method can be called arbitrarily often and each call returns a new instance.
    
    Returns:
    
    a new instance of Nesting
  - addListener
```
public NestedInvalidationListenerHandle addListener(javafx.beans.InvalidationListener listener)
```
    Adds the specified invalidation listener to the nesting hierarchy's inner Observable.
    
    Parameters:
    
    listener - the added InvalidationListener
    
    Returns:
    
    the NestedInvalidationListenerHandle which can be used to check the nesting's state

This documentation is licensed under CC-BY 4.0, attributed to Nicolai Parlog from CodeFX.

Class ObjectPropertyNestingBuilder<T>

Property Summary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

build

Method Detail

nestObservable

nestObservableValue

nestObservableNumberValue

nestProperty

nest

nestBooleanProperty

nestIntegerProperty

nestLongProperty

nestFloatProperty

nestDoubleProperty

nestStringProperty

buildProperty

buildPropertyWithBuilder

addListener

buildNesting

addListener