Package org.dellroad.stuff.vaadin24.data

Class SimplePropertySet<T>

java.lang.Object

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

Type Parameters:

T - underlying target type

All Implemented Interfaces:

PropertySet<T>, Serializable

Direct Known Subclasses:

MapPropertySet

public class SimplePropertySet<T>
extends Object
implements PropertySet<T>

Straightforward implementation of PropertySet using caller-supplied getters and setters.

This class is useful for building arbitrary property sets, e.g., see MapPropertySet.

It's also useful when you need to detect Java bean properties defined by default interface methods. Due to JDK-8071693, Vaadin's Binder fails to detect such bean properties. To work around that bug, you can do something like this:

     // Gather bean properties using Spring's BeanUtils to work around JDK-8071693
     final SimplePropertySet<T> propertySet = new SimplePropertySet<>(beanType);
     Stream.of(BeanUtils.getPropertyDescriptors(beanType))
       .filter(pd -> !(pd instanceof IndexedPropertyDescriptor))
       .filter(pd -> pd.getReadMethod() != null)
       .filter(pd -> pd.getWriteMethod() != null)
       .forEach(propertySet::addPropertyDefinition);

     // Create binder
     final Binder<T> binder = Binder.withPropertySet(propertySet);
 

This class allows you to recover the original property definition from a Binder.Binding instance; see propertyDefinitionForBinding().

Does not support sub-properties.

See Also:

• JDK-8071693
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SimplePropertySet.Definition<V>	A PropertyDefinition within a SimplePropertySet.

Constructor Summary

Constructors

Constructor	Description
SimplePropertySet(Class<T> targetType)	Constructor.

Method Summary

Modifier and Type	Method	Description
SimplePropertySet<T>.Definition<?>	addPropertyDefinition(PropertyDescriptor propertyDescriptor)	Add a new property to this instance corresponding to the given Java bean PropertyDescriptor.
<V> SimplePropertySet<T>.Definition<V>	addPropertyDefinition(String name, Class<V> type, String caption, ValueProvider<? super T,? extends V> getter, Setter<? super T,? super V> setter)	Add a new property to this instance.
protected <V> SimplePropertySet<T>.Definition<V>	createDefinition(String name, Class<V> type, String caption, ValueProvider<? super T,? extends V> getter, Setter<? super T,? super V> setter)	Create a new SimplePropertySet.Definition.
Stream<PropertyDefinition<T,?>>	getProperties()
Optional<PropertyDefinition<T,?>>	getProperty(String name)
Class<T>	getTargetType()	Get the target object type associated with this instance.
static SimplePropertySet<?>.Definition<?>	propertyDefinitionForBinding(Binder.Binding<?,?> binding)	Recover the SimplePropertySet.Definition from the given binding, assuming the associated Binder was created using a SimplePropertySet.

Methods inherited from class java.lang.Object

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

Constructor Details

SimplePropertySet

public SimplePropertySet(Class<T> targetType)

Constructor.

Parameters:

targetType - object type that contains property values

Throws:

IllegalArgumentException - if targetType is null

Method Details

getProperties

public Stream<PropertyDefinition<T,?>> getProperties()

Specified by:

getProperties in interface PropertySet<T>

getProperty

public Optional<PropertyDefinition<T,?>> getProperty(String name)

Specified by:

getProperty in interface PropertySet<T>

getTargetType

public Class<T> getTargetType()

Get the target object type associated with this instance.

The target object stores the actual property values.

Returns:

target object type

addPropertyDefinition

public <V> SimplePropertySet<T>.Definition<V> addPropertyDefinition(String name,
 Class<V> type,
 String caption,
 ValueProvider<? super T,? extends V> getter,
 Setter<? super T,? super V> setter)

Add a new property to this instance.

Parameters:

name - property name

type - property type

caption - property caption

getter - getter method

setter - setter method, or null for none

Returns:

newly created property definition

Throws:

IllegalArgumentException - if any parameter other than setter is null

IllegalArgumentException - if a property with the same name has already been added

addPropertyDefinition

public SimplePropertySet<T>.Definition<?> addPropertyDefinition(PropertyDescriptor propertyDescriptor)

Add a new property to this instance corresponding to the given Java bean PropertyDescriptor.

The caller is responsible for ensuring that propertyDescriptor is compatible with the target object type.

Parameters:

propertyDescriptor - property descriptor

Returns:

newly created property definition

Throws:

IllegalArgumentException - if propertyDescriptor is null

IllegalArgumentException - if propertyDescriptor is an IndexedPropertyDescriptor

IllegalArgumentException - if propertyDescriptor has no getter method

IllegalArgumentException - if a property with the same name has already been added

propertyDefinitionForBinding

public static SimplePropertySet<?>.Definition<?> propertyDefinitionForBinding(Binder.Binding<?,?> binding)

Recover the SimplePropertySet.Definition from the given binding, assuming the associated Binder was created using a SimplePropertySet.

Parameters:

binding - Binder binding

Returns:

binding's associated property definition

Throws:

IllegalArgumentException - if the associated Binder does not use a SimplePropertySet

IllegalArgumentException - if binding is null

createDefinition

protected <V> SimplePropertySet<T>.Definition<V> createDefinition(String name,
 Class<V> type,
 String caption,
 ValueProvider<? super T,? extends V> getter,
 Setter<? super T,? super V> setter)

Create a new SimplePropertySet.Definition.

The implementation in SimplePropertySet just invokes the SimplePropertySet.Definition constructor directly.

Parameters:

name - property name

type - property type

caption - property caption

getter - getter method

setter - setter method, or null for none

Returns:

newly created property definition

Throws:

IllegalArgumentException - if any parameter other than setter is null