Class EnumDataProvider<T extends Enum<T>>

java.lang.Object

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

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

org.dellroad.stuff.vaadin24.data.EnumDataProvider<T>

All Implemented Interfaces:

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

public class EnumDataProvider<T extends Enum<T>>
extends ListDataProvider<T>

A simple data provider containing Enum values.

When created by a FieldBuilder, instances will automatically infer the Enum type via FieldBuilderContext.inferDataModelType() and then populate themselves with the corresponding enum values.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EnumDataProvider(Class<T> type)	Constructor.
EnumDataProvider(FieldBuilderContext ctx)	Auto-build Constructor.

Method Summary

Modifier and Type	Method	Description
Class<T>	getEnumType()	Get the enum type.

Methods inherited from class ListDataProvider

fetch, getFilter, getItems, getSortComparator, setFilter, setSortComparator, size

Methods inherited from class AbstractDataProvider

addDataProviderListener, addListener, fireEvent, refreshAll, refreshItem, refreshItem

Methods inherited from class Object

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

Methods inherited from interface DataProvider

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

Methods inherited from interface InMemoryDataProvider

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

Constructor Details

EnumDataProvider

public EnumDataProvider(FieldBuilderContext ctx)

Auto-build Constructor.

This constructor will infer the Enum type from the annotated method's return value.

Parameters:

ctx - field builder context

Throws:

NullPointerException - if ctx is null

EnumDataProvider

public EnumDataProvider(Class<T> type)

Constructor.

Parameters:

type - enum type

Throws:

IllegalArgumentException - if type is null

ClassCastException - if type is not an Enum type

Method Details

getEnumType

public Class<T> getEnumType()

Get the enum type.

Returns:

enum type