io.datafx.provider

Class ObjectDataProviderBuilder<T>

java.lang.Object

io.datafx.provider.ObjectDataProviderBuilder<T>

Type Parameters:

T - the type of data that the ObjectDataProvider created by this builder will deliver

public final class ObjectDataProviderBuilder<T>
extends java.lang.Object

Builder class for creating an ObjectDataProvider.

Method Summary

Modifier and Type	Method and Description
ObjectDataProvider	build() Construct the ObjectDataProvider that will provide the data.
static <T> ObjectDataProviderBuilder	create() Creates the initial builder.
ObjectDataProviderBuilder	dataReader(DataReader<T> dataReader) Provides the DataReader that contains the data
ObjectDataProviderBuilder	resultProperty(javafx.beans.property.ObjectProperty<T> result) Pass an ObjectProperty that should be filled with the retrieved value.
ObjectDataProviderBuilder	writeBackHandler(WriteBackHandler<T> handler) Provide a handler that will be called when the retrieved data is changed locally.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> ObjectDataProviderBuilder create()

Creates the initial builder.

Type Parameters:

T - the type of the data that is expected to be returned

Returns:

the builder instance

dataReader

public ObjectDataProviderBuilder dataReader(DataReader<T> dataReader)

Provides the DataReader that contains the data

Parameters:

dataReader - the DataReader instance that should be used by the ObjectDataProvider

Returns:

this builder instance

resultProperty

public ObjectDataProviderBuilder resultProperty(javafx.beans.property.ObjectProperty<T> result)

Pass an ObjectProperty that should be filled with the retrieved value.

Parameters:

result - the ObjectProperty that we want to be used for setting the data

Returns:

this builder instance

writeBackHandler

public ObjectDataProviderBuilder writeBackHandler(WriteBackHandler<T> handler)

Provide a handler that will be called when the retrieved data is changed locally.

Parameters:

handler - the WriteBackHandler instance

Returns:

this builder instance

build

public ObjectDataProvider build()

Construct the ObjectDataProvider that will provide the data. See ObjectDataProvider for information on how to retrieve the data.

Returns:

the created ObjectDataProvider