Class AbstractFieldBuilder<S extends AbstractFieldBuilder<S,T>, T>

java.lang.Object

org.dellroad.stuff.vaadin25.field.AbstractFieldBuilder<S,T>

Type Parameters:

S - subclass type

T - edited model type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractGridFieldBuilder

public abstract class AbstractFieldBuilder<S extends AbstractFieldBuilder<S,T>, T>
extends Object
implements Serializable

Provides the machinery for auto-generated FieldBuilder-like classes.

The annotation classes defined in this class, which are common to all FieldBuilder-like classes, may be referenced using the concrete subclass name for consistency. For example, code can reference @FieldBuilder.Binding instead of @AbstractFieldBuilder.Binding.

See FieldBuilder for details and the standard implementation.

See Also:

• FieldBuilder
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	AbstractFieldBuilder.Binding	Specifies properties of the Binder binding itself.
class	AbstractFieldBuilder.BindingInfo	FieldBuilder static configuration information for one bean property.
static class	AbstractFieldBuilder.DefaultInfo	Holds static information gathered from scanning @FieldBuilder.FieldDefault annotations.
static @interface	AbstractFieldBuilder.EnabledBy	Causes the generated field to be automatically enabled or disabled based on the value of some other controlling field(s).
static @interface	AbstractFieldBuilder.FieldDefault	Declare alternate default values for properties of the Vaadin fields created by @FieldBuilder.
static @interface	AbstractFieldBuilder.FormLayout	Configures how FieldBuilder.addFieldComponents() adds a generated field to a FormLayout.
static @interface	AbstractFieldBuilder.NullifyCheckbox	Causes the field that would otherwise be used for a property to be wrapped in a NullableField, which adds a Checkbox that controls whether the value is null or not.
static @interface	AbstractFieldBuilder.ProvidesField	Specifies that the annotated method will create a field suitable for editing the specified property.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ANNOTATION_DEFAULTS_METHOD_NAME
static final String	DEFAULT_IMPLEMENTATION_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFieldBuilder(Class<T> type)	Constructor.
protected	AbstractFieldBuilder(AbstractFieldBuilder<S,T> original)	Static information copy constructor.

Method Summary

Modifier and Type	Method	Description
void	addFieldComponents(FormLayout formLayout)	Add the fields' components created by this instance in the previous call to bindFields() to the given FormLayout.
protected void	applyFieldDefaultAnnotations(HasValue<?,?> field, Class<?> modelType)	Apply defaults derived from @FieldBuilder.FieldDefault annotations to the given field.
void	bindFields(Binder<? extends T> binder)	Create, configure, and bind fields into the given Binder.
protected Map<Class<? extends Annotation>, Annotation>	buildDeclarativeAnnotationsMap()	Get all of the declarative widget annotation types defined for this class and their default values.
protected FieldComponent<?>	buildDeclarativeField(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo)	Construct and configure a field based on a @FieldBuilder.Foo declarative annotation.
protected FieldComponent<?>	buildProvidedField(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo, MethodAnnotationScanner<T, AbstractFieldBuilder.ProvidesField>.MethodInfo methodInfo, Object bean)	Construct a field and corresponding component using a @FieldBuilder.ProvidesField annotated method.
protected AbstractFieldBuilder<S,T>.BindingInfo	createBindingInfo(Method method, String propertyName, Annotation annotation, AbstractFieldBuilder.Binding binding, AbstractFieldBuilder.FormLayout formLayout, AbstractFieldBuilder.NullifyCheckbox nullifyCheckbox, AbstractFieldBuilder.EnabledBy enabledBy, BiFunction<AbstractFieldBuilder<S,T>.BindingInfo, ? super T, FieldComponent<?>> fieldBuilder)	Create a AbstractFieldBuilder<S extends AbstractFieldBuilder<S,T>, T>.BindingInfo.
Map<String, FieldComponent<?>>	getFieldComponents()	Obtain the fields created by this instance in the most recent call to bindFields().
protected String	getImplementationPropertyName()	Get the name of the annotation property that specifies the implementation class.
Map<Class<?>, Map<String, AbstractFieldBuilder.DefaultInfo>>	getScannedFieldDefaults()	Get the field property default values discovered by this instance (if any) from scanned @FieldBuilder.FieldDefault annotations.
Map<String, AbstractFieldBuilder<S,T>.BindingInfo>	getScannedProperties()	Get all of the properties discovered by this instance from scanned annotations.
Class<T>	getType()	Get the type associated with this instance.
protected <F> F	instantiate(Class<F> expectedType, AbstractFieldBuilder<S,T>.BindingInfo bindingInfo, Annotation annotation, String propertyName)	Instantiate a field (or whatever) from the given Class-valued annotation property.
protected <T> T	instantiate(Class<T> type, AbstractFieldBuilder<S,T>.BindingInfo bindingInfo)	Instantiate a field (or whatever) from the given Class.
protected FieldBuilderContext	newFieldBuilderContext(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo)	Create an FieldBuilderContext from the given method and annotation.
protected void	scanForAnnotations()	Introspect the configured class for defined @FieldBuilder.Foo, @FieldBuilder.ProvidesField, @FieldBuilder.Binding, and @FieldBuilder.FormLayout annotations.
protected <M> Map<String, AbstractFieldBuilder.DefaultInfo>	scanForFieldDefaultAnnotations(Class<M> modelType)	Scan the given model type for @FieldBuilder.FieldDefault annotations.

Methods inherited from class Object

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

Field Details

DEFAULT_IMPLEMENTATION_PROPERTY_NAME

public static final String DEFAULT_IMPLEMENTATION_PROPERTY_NAME

See Also:

• Constant Field Values

DEFAULT_ANNOTATION_DEFAULTS_METHOD_NAME

public static final String DEFAULT_ANNOTATION_DEFAULTS_METHOD_NAME

See Also:

• Constant Field Values

Constructor Details

AbstractFieldBuilder

protected AbstractFieldBuilder(Class<T> type)

Constructor.

Parameters:

type - backing object type

Throws:

IllegalArgumentException - if type is null

AbstractFieldBuilder

protected AbstractFieldBuilder(AbstractFieldBuilder<S,T> original)

Static information copy constructor.

Using this constructor is more efficient than repeatedly scanning the same classes for the same annotations.

Only the static information gathered by this instance by scanning for annotations is copied. Any previously built fields are not copied.

Parameters:

original - original instance

Throws:

IllegalArgumentException - if original is null

Method Details

getType

public Class<T> getType()

Get the type associated with this instance.

Returns:

configured type

getScannedProperties

public Map<String, AbstractFieldBuilder<S,T>.BindingInfo> getScannedProperties()

Get all of the properties discovered by this instance from scanned annotations.

This represents static information gathered by this instance by scanning the class hierarchy during construction.

The returned Map iterates in order of @FieldBuilder.FormLayout.order(), then by property name.

Returns:

unmodifiable mapping of scanned properties keyed by property name

getScannedFieldDefaults

public Map<Class<?>, Map<String, AbstractFieldBuilder.DefaultInfo>> getScannedFieldDefaults()

Get the field property default values discovered by this instance (if any) from scanned @FieldBuilder.FieldDefault annotations.

The returned map is keyed by the return types of methods found with @FieldBuilder.Foo declarative annotations.

This represents static information gathered by this instance by scanning the class hierarchy during construction.

Returns:

unmodifiable mapping from model class to field defaults keyed by field property name

bindFields

public void bindFields(Binder<? extends T> binder)

Create, configure, and bind fields into the given Binder.

If the binder does not have a bean currently bound to it, then any @FieldBuilder.ProvidesField annotations on instance methods will generate an error.

After this method completes, the associated components can be obtained via getFieldComponents() or added to a FormLayout via addFieldComponents().

Parameters:

binder - target binder

Throws:

IllegalArgumentException - if invalid annotation use is encountered

IllegalArgumentException - if binder is null

getFieldComponents

public Map<String, FieldComponent<?>> getFieldComponents()

Obtain the fields created by this instance in the most recent call to bindFields().

The returned Map iterates in order of @FieldBuilder.FormLayout.order(), then by property name.

Returns:

unmodifiable mapping from property name to field/component

Throws:

IllegalStateException - if bindFields() has not yet been invoked

addFieldComponents

public void addFieldComponents(FormLayout formLayout)

Add the fields' components created by this instance in the previous call to bindFields() to the given FormLayout.

The field components are added in order of @FieldBuilder.FormLayout.order(), then by property name.

Parameters:

formLayout - target layout

Throws:

IllegalArgumentException - if formLayout is null

IllegalStateException - if bindFields() has not yet been invoked

IllegalStateException - if this method is invoked twice in a row without an intervening call to bindFields()

scanForAnnotations

protected void scanForAnnotations()

Introspect the configured class for defined @FieldBuilder.Foo, @FieldBuilder.ProvidesField, @FieldBuilder.Binding, and @FieldBuilder.FormLayout annotations.

Note: this method is invoked from the AbstractFieldBuilder constructor.

Throws:

IllegalArgumentException - if an invalid use of an annotation is encountered

scanForFieldDefaultAnnotations

protected <M>
Map<String, AbstractFieldBuilder.DefaultInfo> scanForFieldDefaultAnnotations(Class<M> modelType)

Scan the given model type for @FieldBuilder.FieldDefault annotations.

Type Parameters:

M - model type

Parameters:

modelType - model type for some edited property

Returns:

mapping from field property name to default info for that property (possibly empty)

Throws:

IllegalArgumentException - if modelType is null

buildDeclarativeField

protected FieldComponent<?> buildDeclarativeField(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo)

Construct and configure a field based on a @FieldBuilder.Foo declarative annotation.

Parameters:

bindingInfo - field binding context

Returns:

new field

applyFieldDefaultAnnotations

protected void applyFieldDefaultAnnotations(HasValue<?,?> field,
 Class<?> modelType)

Apply defaults derived from @FieldBuilder.FieldDefault annotations to the given field.

Parameters:

field - the field being configured

modelType - the type of the property edited by field

Throws:

IllegalArgumentException - if either parameter is null

buildProvidedField

protected FieldComponent<?> buildProvidedField(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo,
 MethodAnnotationScanner<T, AbstractFieldBuilder.ProvidesField>.MethodInfo methodInfo,
 Object bean)

Construct a field and corresponding component using a @FieldBuilder.ProvidesField annotated method.

Parameters:

bindingInfo - field binding context

methodInfo - scanned annotation context

bean - binder bean, or null if none

Returns:

new field

buildDeclarativeAnnotationsMap

protected Map<Class<? extends Annotation>, Annotation> buildDeclarativeAnnotationsMap()

Get all of the declarative widget annotation types defined for this class and their default values.

The implementation in AbstractFieldBuilder gleans this information using reflection by looking for a method named "annotationDefaultsMethod"<S extends AbstractFieldBuilder<S,T>, T> taking zero parameters declared by this class or some superclass and returning all annotations on that method. Subclasses may override this method to augment or modify this information.

Entries in the map may have null values if defaults are handled differently in a subclass' overridden buildDeclarativeField().

Returns:

mutable mapping from widget annotation types to default values

createBindingInfo

protected AbstractFieldBuilder<S,T>.BindingInfo createBindingInfo(Method method,
 String propertyName,
 Annotation annotation,
 AbstractFieldBuilder.Binding binding,
 AbstractFieldBuilder.FormLayout formLayout,
 AbstractFieldBuilder.NullifyCheckbox nullifyCheckbox,
 AbstractFieldBuilder.EnabledBy enabledBy,
 BiFunction<AbstractFieldBuilder<S,T>.BindingInfo, ? super T, FieldComponent<?>> fieldBuilder)

Create a AbstractFieldBuilder<S extends AbstractFieldBuilder<S,T>, T>.BindingInfo.

Parameters:

method - annotated method

propertyName - property name

annotation - annotation found on method

binding - associated @FieldBuilder.Binding annotation, if any

formLayout - associated @FieldBuilder.FormLayout annotation, if any

nullifyCheckbox - associated from @FieldBuilder.NullifyCheckbox, if any

enabledBy - associated from @FieldBuilder.EnabledBy, if any

fieldBuilder - builds the field

Returns:

new AbstractFieldBuilder<S extends AbstractFieldBuilder<S,T>, T>.BindingInfo, or null if this property should be ignored

Throws:

IllegalArgumentException - if method, propertyName, annotation, or fieldBuilder is null

getImplementationPropertyName

protected String getImplementationPropertyName()

Get the name of the annotation property that specifies the implementation class.

The implementation in AbstractFieldBuilder returns "implementation"<S extends AbstractFieldBuilder<S,T>, T>.

Returns:

implementation property name, never null

instantiate

protected <F> F instantiate(Class<F> expectedType,
 AbstractFieldBuilder<S,T>.BindingInfo bindingInfo,
 Annotation annotation,
 String propertyName)

Instantiate a field (or whatever) from the given Class-valued annotation property.

We use the FieldBuilderContext constructor if available, otherwise default constructor.

Type Parameters:

F - field type

Parameters:

expectedType - expected type of thing we're instantiating

bindingInfo - binding context

annotation - annotation with Class-valued property

propertyName - annotation property name having type Class

Throws:

IllegalArgumentException - if any parameter is null

instantiate

protected <T> T instantiate(Class<T> type,
 AbstractFieldBuilder<S,T>.BindingInfo bindingInfo)

Instantiate a field (or whatever) from the given Class.

We use the FieldBuilderContext constructor if available, otherwise default constructor.

Parameters:

type - expected type of the thing we're instantiating

bindingInfo - binding context

Throws:

IllegalArgumentException - if any parameter is null

newFieldBuilderContext

protected FieldBuilderContext newFieldBuilderContext(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo)

Create an FieldBuilderContext from the given method and annotation.

The implementation in AbstractFieldBuilder creates a FieldBuilderContextImpl.

Parameters:

bindingInfo - binding context

Throws:

IllegalArgumentException - if bindingInfo is null