Package org.dellroad.stuff.vaadin24.field

Class AbstractFieldBuilder.BindingInfo

java.lang.Object

org.dellroad.stuff.vaadin24.field.AbstractFieldBuilder.BindingInfo

Enclosing class:

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

public class AbstractFieldBuilder.BindingInfo
extends Object

FieldBuilder static configuration information for one bean property.

This class captures the information gathered from these annotations for some bean property:

• @FieldBuilder.Foo (for some widget class Foo)
• @FieldBuilder.ProvidesField
• @FieldBuilder.Binding
• @FieldBuilder.FormLayout
• @FieldBuilder.NullifyCheckbox
• @FieldBuilder.EnabledBy

Instances are immutable.

Constructor Summary

Constructors

Constructor	Description
BindingInfo(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)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addField(FormLayout formLayout, Component component)	Add the given component to the given FormLayout according to this instance.
protected <T> FieldComponent<T>	addNullifyCheckbox(FieldComponent<T> fieldComponent)
<V> Binder.Binding<? extends T,?>	bind(Binder<? extends T> binder, HasValue<?,V> field)	Bind the given field to the given Binder according to this instance.
FieldComponent<?>	createFieldComponent(T bean)	Instantiate a new field and associated component according to this instance.
Annotation	getAnnotation()	Get the (@FieldBuilder.Foo or @FieldBuilder.ProvidesField) annotation that annotates the method from which this instance originated.
AbstractFieldBuilder.Binding	getBinding()	Get the associated @FieldBuilder.Binding annotation, if any.
AbstractFieldBuilder.EnabledBy	getEnabledBy()	Get the associated @FieldBuilder.EnabledBy annotation, if any.
AbstractFieldBuilder<S,T>	getFieldBuilder()	Return the AbstractFieldBuilder that created this instance.
AbstractFieldBuilder.FormLayout	getFormLayout()	Get the associated @FieldBuilder.FormLayout annotation, if any.
protected String	getLabel(Object obj)	Find a public zero-arg method getLabel returning String and invoke it, if it exists.
Method	getMethod()	Get the annotated method associated with this instance.
AbstractFieldBuilder.NullifyCheckbox	getNullifyCheckbox()	Get the associated @FieldBuilder.NullifyCheckbox annotation, if any.
String	getOrigin()	Get a description of the origin of this instance (method and annotation).
String	getPropertyName()	Return the property name associated with this instance.
double	getSortOrder()	Generate a sorting value for this field.
protected <T> T	instantiate(Class<T> type)	Instantiate a field (or whatever) from the given Class.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BindingInfo

public BindingInfo(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)

Constructor.

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 @FieldBuilder.NullifyCheckbox, if any

enabledBy - associated from @FieldBuilder.EnabledBy, if any

fieldBuilder - builds the field

Throws:

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

Method Details

getFieldBuilder

public AbstractFieldBuilder<S,T> getFieldBuilder()

Return the AbstractFieldBuilder that created this instance.

Returns:

associated field builder

getMethod

public Method getMethod()

Get the annotated method associated with this instance.

This is the method that is annotated with the @FieldBuilder.Foo annotation. Note that the other annotations (e.g., @FieldBuilder.Binding) could possibly have come from different methods (they would necessarily be overriding or overridden versions of this method).

Returns:

associated method

getPropertyName

public String getPropertyName()

Return the property name associated with this instance.

Returns:

associated property name

getAnnotation

public Annotation getAnnotation()

Get the (@FieldBuilder.Foo or @FieldBuilder.ProvidesField) annotation that annotates the method from which this instance originated.

Returns:

associated annotation type

getBinding

public AbstractFieldBuilder.Binding getBinding()

Get the associated @FieldBuilder.Binding annotation, if any.

Returns:

associated @FieldBuilder.Binding annotation, or null if none

getFormLayout

public AbstractFieldBuilder.FormLayout getFormLayout()

Get the associated @FieldBuilder.FormLayout annotation, if any.

Returns:

associated @FieldBuilder.FormLayout annotation, or null if none

getNullifyCheckbox

public AbstractFieldBuilder.NullifyCheckbox getNullifyCheckbox()

Get the associated @FieldBuilder.NullifyCheckbox annotation, if any.

Returns:

associated @FieldBuilder.NullifyCheckbox annotation, or null if none

getEnabledBy

public AbstractFieldBuilder.EnabledBy getEnabledBy()

Get the associated @FieldBuilder.EnabledBy annotation, if any.

Returns:

associated @FieldBuilder.EnabledBy annotation, or null if none

getSortOrder

public double getSortOrder()

Generate a sorting value for this field.

Returns:

sort order value

getOrigin

public String getOrigin()

Get a description of the origin of this instance (method and annotation).

Returns:

origin description

instantiate

protected <T> T instantiate(Class<T> type)

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

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

Parameters:

type - expected type of thing we're instantiating

createFieldComponent

public FieldComponent<?> createFieldComponent(T bean)

Instantiate a new field and associated component according to this instance.

Parameters:

bean - instance bean, or null if none available

Returns:

new field and associated component

Throws:

IllegalArgumentException - if a bean instance is required but bean is null

addNullifyCheckbox

protected <T> FieldComponent<T> addNullifyCheckbox(FieldComponent<T> fieldComponent)

bind

public <V> Binder.Binding<? extends T,?> bind(Binder<? extends T> binder,
 HasValue<?,V> field)

Bind the given field to the given Binder according to this instance.

Type Parameters:

V - field value type

Parameters:

binder - binder to bind new field to

field - field to bind

Returns:

the new binding

Throws:

IllegalArgumentException - if either parameter is null

addField

public void addField(FormLayout formLayout,
 Component component)

Add the given component to the given FormLayout according to this instance.

Parameters:

formLayout - target layout

component - field component to add

Throws:

IllegalArgumentException - if either parameter is null

getLabel

protected String getLabel(Object obj)

Find a public zero-arg method getLabel returning String and invoke it, if it exists.

Parameters:

obj - target object

Returns:

the returned label, or null on failure

toString

public String toString()

Overrides:

toString in class Object