io.datafx.provider

Class ListDataProviderBuilder<T>

java.lang.Object

io.datafx.provider.ListDataProviderBuilder<T>

Type Parameters:

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

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

Builder class for creating an ListDataProvider.

Method Summary

Modifier and Type	Method and Description
ListDataProviderBuilder	addEntryHandler(WriteBackHandler<T> handler) Provide a handler that will be called when a new entry is added to the ObservableList instance passed via the resultList method by means of a local call (i.e.
ListDataProvider	build() Construct the ListDataProvider that will provide the data.
static <T> ListDataProviderBuilder	create() Creates the initial builder.
ListDataProviderBuilder	dataReader(DataReader<T> dataReader) Provides the DataReader that contains the data
ListDataProviderBuilder	resultList(javafx.collections.ObservableList<T> result) Pass an ObservableList that should be filled with the retrieved values.
ListDataProviderBuilder	writeBackHandler(WriteBackHandler<T> handler) Provide a handler that will be called when an entry of 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> ListDataProviderBuilder 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 ListDataProviderBuilder dataReader(DataReader<T> dataReader)

Provides the DataReader that contains the data

Parameters:

dataReader - the DataReader instance that contains the data

Returns:

this builder instance

resultList

public ListDataProviderBuilder resultList(javafx.collections.ObservableList<T> result)

Pass an ObservableList that should be filled with the retrieved values.

Parameters:

result - the ObservableList that we want to filled with the retrieved values

Returns:

this builder instance

writeBackHandler

public ListDataProviderBuilder writeBackHandler(WriteBackHandler<T> handler)

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

Parameters:

handler - the WriteBackHandler instance

Returns:

this builder instance

addEntryHandler

public ListDataProviderBuilder addEntryHandler(WriteBackHandler<T> handler)

Provide a handler that will be called when a new entry is added to the ObservableList instance passed via the resultList method by means of a local call (i.e. not because new external data is available).

Parameters:

handler - the WriteBackHandler instance

Returns:

this builder instance

build

public ListDataProvider build()

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

Returns:

the created ListDataProvider