Package com.vaadin.flow.data.provider

Class ListDataProvider<T>

java.lang.Object

com.vaadin.flow.data.provider.AbstractDataProvider<T,SerializablePredicate<T>>

com.vaadin.flow.data.provider.ListDataProvider<T>

Type Parameters:

T - data type

All Implemented Interfaces:

ConfigurableFilterDataProvider<T,SerializablePredicate<T>,SerializablePredicate<T>>, DataProvider<T,SerializablePredicate<T>>, InMemoryDataProvider<T>, Serializable

Direct Known Subclasses:

DataCommunicator.EmptyDataProvider

public class ListDataProvider<T>
extends AbstractDataProvider<T,SerializablePredicate<T>>
implements InMemoryDataProvider<T>

DataProvider wrapper for Collections.

Since:

1.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ListDataProvider(Collection<T> items)	Constructs a new ListDataProvider.

Method Summary

Modifier and Type	Method	Description
Stream<T>	fetch(Query<T,SerializablePredicate<T>> query)	Fetches data from this DataProvider using given query.
SerializablePredicate<T>	getFilter()	Gets the current filter of this data provider.
Collection<T>	getItems()	Returns the underlying data items.
SerializableComparator<T>	getSortComparator()	Gets the current sort comparator of this data provider.
void	setFilter(SerializablePredicate<T> filter)	Sets a filter to be applied to all queries.
void	setSortComparator(SerializableComparator<T> comparator)	Sets the comparator to use as the default sorting for this data provider.
int	size(Query<T,SerializablePredicate<T>> query)	Gets the amount of data in this DataProvider.

Methods inherited from class com.vaadin.flow.data.provider.AbstractDataProvider

addDataProviderListener, addListener, fireEvent, refreshAll, refreshItem, refreshItem

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.data.provider.DataProvider

addDataProviderListener, getId, refreshAll, refreshItem, refreshItem, withConfigurableFilter, withConfigurableFilter, withConvertedFilter

Methods inherited from interface com.vaadin.flow.data.provider.InMemoryDataProvider

addFilter, addFilter, addFilterByValue, addSortComparator, addSortOrder, clearFilters, filteringBy, filteringBy, filteringByEquals, filteringByPrefix, filteringByPrefix, filteringBySubstring, filteringBySubstring, isInMemory, setFilter, setFilterByValue, setSortOrder

Constructor Details

ListDataProvider

public ListDataProvider(Collection<T> items)

Constructs a new ListDataProvider.

No protective copy is made of the list, and changes in the provided backing Collection will be visible via this data provider. The caller should copy the list if necessary.

Parameters:

items - the initial data, not null

Method Details

getItems

public Collection<T> getItems()

Returns the underlying data items.

Returns:

the underlying data items

fetch

public Stream<T> fetch(Query<T,SerializablePredicate<T>> query)

Description copied from interface: DataProvider

Fetches data from this DataProvider using given query.

Specified by:

fetch in interface DataProvider<T,SerializablePredicate<T>>

Parameters:

query - given query to request data

Returns:

the result of the query request: a stream of data objects, not null

size

public int size(Query<T,SerializablePredicate<T>> query)

Description copied from interface: DataProvider

Gets the amount of data in this DataProvider.

Specified by:

size in interface DataProvider<T,SerializablePredicate<T>>

Parameters:

query - query with sorting and filtering

Returns:

the size of the data provider

getSortComparator

public SerializableComparator<T> getSortComparator()

Description copied from interface: InMemoryDataProvider

Gets the current sort comparator of this data provider.

Specified by:

getSortComparator in interface InMemoryDataProvider<T>

Returns:

the sort comparator of this data provider

setSortComparator

public void setSortComparator(SerializableComparator<T> comparator)

Description copied from interface: InMemoryDataProvider

Sets the comparator to use as the default sorting for this data provider. This overrides the sorting set by any other method that manipulates the default sorting of this data provider.

The default sorting is used if the query defines no sorting. The default sorting is also used to determine the ordering of items that are considered equal by the sorting defined in the query.

Specified by:

setSortComparator in interface InMemoryDataProvider<T>

Parameters:

comparator - a comparator to use, or null to clear any previously set sort order

See Also:

• InMemoryDataProvider.setSortOrder(ValueProvider, SortDirection)
• InMemoryDataProvider.addSortComparator(SerializableComparator)

getFilter

public SerializablePredicate<T> getFilter()

Description copied from interface: InMemoryDataProvider

Gets the current filter of this data provider.

Specified by:

getFilter in interface InMemoryDataProvider<T>

Returns:

the filter of this data provider

setFilter

public void setFilter(SerializablePredicate<T> filter)

Description copied from interface: InMemoryDataProvider

Sets a filter to be applied to all queries. The filter replaces any filter that has been set or added previously.

Specified by:

setFilter in interface ConfigurableFilterDataProvider<T,SerializablePredicate<T>,SerializablePredicate<T>>

Specified by:

setFilter in interface InMemoryDataProvider<T>

Parameters:

filter - the filter to set, or null to remove any set filters

See Also:

• InMemoryDataProvider.setFilter(ValueProvider, SerializablePredicate)
• InMemoryDataProvider.setFilterByValue(ValueProvider, Object)
• InMemoryDataProvider.addFilter(SerializablePredicate)