Package org.dellroad.stuff.vaadin7

Class EnumContainer<T extends Enum<T>>

java.lang.Object

com.vaadin.data.util.AbstractContainer

com.vaadin.data.util.AbstractInMemoryContainer<I,String,BackedItem<T>>

org.dellroad.stuff.vaadin7.AbstractSimpleContainer<I,T>

org.dellroad.stuff.vaadin7.SimpleKeyedContainer<T,T>

org.dellroad.stuff.vaadin7.SelfKeyedContainer<T>

org.dellroad.stuff.vaadin7.EnumContainer<T>

Type Parameters:

T - enum type

All Implemented Interfaces:

Container, Container.Filterable, Container.Indexed, Container.ItemSetChangeNotifier, Container.Ordered, Container.SimpleFilterable, Container.Sortable, Serializable, Connectable, PropertyExtractor<T>

public class EnumContainer<T extends Enum<T>>
extends SelfKeyedContainer<T>

Container backed by the instances of an Enum type.

Instances will auto-detect properties defined by @ProvidesProperty annotations (if any), and will also pre-define the following properties:

• "name" - String property derived from Enum.name()
• "value" - type T property that returns the Enum instance value itself
• "ordinal" - Integer property derived from Enum.ordinal()
• "toString" - String property derived from Enum.toString()

See Also:

EnumComboBox, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.data.util.AbstractInMemoryContainer

AbstractInMemoryContainer.BaseItemAddEvent, AbstractInMemoryContainer.BaseItemRemoveEvent

Nested classes/interfaces inherited from class com.vaadin.data.util.AbstractContainer

AbstractContainer.BaseItemSetChangeEvent, AbstractContainer.BasePropertySetChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Container

Container.Editor, Container.Filter, Container.Filterable, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeEvent, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeEvent, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.SimpleFilterable, Container.Sortable, Container.Viewer

Nested classes/interfaces inherited from interface com.vaadin.data.Container.Indexed

Container.Indexed.ItemAddEvent, Container.Indexed.ItemRemoveEvent

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME_PROPERTY
static String	ORDINAL_PROPERTY
static String	TO_STRING_PROPERTY
static String	VALUE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
EnumContainer(Class<T> type)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected List<T>	getExposedValues(Class<T> type)	Get the Enum values to expose in this container in the desired order.
<V> V	getPropertyValue(T value, PropertyDef<V> propertyDef)	Read the value of the property defined by propertyDef from the given object.

Methods inherited from class org.dellroad.stuff.vaadin7.SelfKeyedContainer

getKeyFor

Methods inherited from class org.dellroad.stuff.vaadin7.SimpleKeyedContainer

generateItemId, getItemIdFor, getItemIdForSame, getJavaObject, resetItemIds

Methods inherited from class org.dellroad.stuff.vaadin7.AbstractSimpleContainer

addContainerFilter, addContainerFilter, afterReload, connect, createBackedItem, disconnect, getContainerFilters, getContainerProperty, getContainerPropertyIds, getItemIds, getPropertyExtractor, getSortableContainerPropertyIds, getType, getUnfilteredItem, internalRemoveAllItems, load, load, removeAllContainerFilters, removeContainerFilter, removeContainerFilters, setProperties, setProperty, setPropertyExtractor, sort

Methods inherited from class com.vaadin.data.util.AbstractInMemoryContainer

addContainerProperty, addFilter, addItem, addItem, addItemAfter, addItemAfter, addItemAt, addItemAt, addItemSetChangeListener, addListener, containsId, doFilterContainer, doSort, filterAll, fireItemAdded, fireItemRemoved, fireItemsAdded, fireItemsRemoved, firstItemId, getAllItemIds, getFilteredItemIds, getFilters, getFirstVisibleItem, getIdByIndex, getItem, getItemIds, getItemSorter, getSortablePropertyIds, getVisibleItemIds, hasContainerFilters, indexOfId, internalAddItemAfter, internalAddItemAt, internalAddItemAtEnd, internalRemoveItem, isFiltered, isFirstId, isLastId, isPropertyFiltered, lastItemId, nextItemId, passesFilters, prevItemId, registerNewItem, removeAllFilters, removeAllItems, removeContainerProperty, removeFilter, removeFilters, removeItem, removeItemSetChangeListener, removeListener, setAllItemIds, setFilteredItemIds, setFilters, setItemSorter, size, sortContainer

Methods inherited from class com.vaadin.data.util.AbstractContainer

addListener, addPropertySetChangeListener, fireContainerPropertySetChange, fireContainerPropertySetChange, fireItemSetChange, fireItemSetChange, getItemSetChangeListeners, getListeners, getPropertySetChangeListeners, removeListener, removePropertySetChangeListener, setItemSetChangeListeners, setPropertySetChangeListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.data.Container

addContainerProperty, addItem, addItem, containsId, getItem, removeAllItems, removeContainerProperty, removeItem, size

Methods inherited from interface com.vaadin.data.Container.Ordered

addItemAfter, addItemAfter, firstItemId, isFirstId, isLastId, lastItemId, nextItemId, prevItemId

Field Detail

NAME_PROPERTY

public static final String NAME_PROPERTY

See Also:

Constant Field Values

VALUE_PROPERTY

public static final String VALUE_PROPERTY

See Also:

Constant Field Values

ORDINAL_PROPERTY

public static final String ORDINAL_PROPERTY

See Also:

Constant Field Values

TO_STRING_PROPERTY

public static final String TO_STRING_PROPERTY

See Also:

Constant Field Values

Constructor Detail

EnumContainer

public EnumContainer(Class<T> type)

Constructor.

Parameters:

type - enum type

Throws:

IllegalArgumentException - if type is null

IllegalArgumentException - if type has a @ProvidesProperty-annotated method with no property name specified has a name which cannot be interpreted as a bean property "getter" method

IllegalArgumentException - if type has two @ProvidesProperty-annotated fields or methods with the same property name

Method Detail

getExposedValues

protected List<T> getExposedValues(Class<T> type)

Get the Enum values to expose in this container in the desired order.

The implementation in EnumContainer returns all values in their natural order. Subclasses may override to filter and/or re-order.

Parameters:

type - enum class instance

Returns:

instances to include in container

getPropertyValue

public <V> V getPropertyValue(T value,
                              PropertyDef<V> propertyDef)

Description copied from class: AbstractSimpleContainer

Read the value of the property defined by propertyDef from the given object.

The implementation in AbstractSimpleContainer just delegates to the configured PropertyExtractor; subclasses may override to customize property extraction.

Specified by:

getPropertyValue in interface PropertyExtractor<T extends Enum<T>>

Overrides:

getPropertyValue in class AbstractSimpleContainer<T extends Enum<T>,T extends Enum<T>>

Type Parameters:

V - value type

Parameters:

value - Java object

propertyDef - definition of which property to read

Returns:

property value