Package org.dellroad.stuff.vaadin8

Class GridColumnScanner<T>

java.lang.Object

org.dellroad.stuff.vaadin8.GridColumnScanner<T>

Type Parameters:

T - Java class to be introspected

public class GridColumnScanner<T>
extends Object

Scans a Java class hierarchy for @GridColumn annotated getter methods, and auto-generates and configures corresponding Grid.Columns on a Grid instance.

This class will also introspect for FieldBuilder annotations and configure editor bindings accordingly via FieldBuilder.setEditorBindings(com.vaadin.ui.Grid<T>).

See GridColumn for an example of usage.

See Also:

GridColumn, FieldBuilder.setEditorBindings(com.vaadin.ui.Grid<T>)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Grid<T>	buildGrid()	Build a Grid with columns auto-generated from introspected @GridColumn annotations.
<G extends Grid<T>> G	buildGrid(Function<? super PropertySet<T>,G> creator)	Build a Grid with columns auto-generated from introspected @GridColumn annotations, using the given function to instantiate the Grid.
Map<String,MethodAnnotationScanner.MethodInfo>	getColumnMap()	Get the annotations found through introspection keyed by property name.
protected String	getPropertyName(MethodAnnotationScanner.MethodInfo methodInfo)	Get the property name from the annotation.
Class<T>	getType()	Get the type associated with this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridColumnScanner

public GridColumnScanner(Class<T> type)

Constructor.

Parameters:

type - Java class to be introspected

Throws:

IllegalArgumentException - if type is null

IllegalArgumentException - if an 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 @GridColumn-annotated fields or methods with the same property name

Method Detail

buildGrid

public Grid<T> buildGrid()

Build a Grid with columns auto-generated from introspected @GridColumn annotations.

The implementation in GridColumnScanner simply invokes this.buildGrid(Grid::withPropertySet).

Returns:

new Grid

buildGrid

public <G extends Grid<T>> G buildGrid(Function<? super PropertySet<T>,G> creator)

Build a Grid with columns auto-generated from introspected @GridColumn annotations, using the given function to instantiate the Grid.

Type Parameters:

G - Grid type

Parameters:

creator - function that creates a new Grid instance given a PropertySet

Returns:

new Grid

Throws:

IllegalArgumentException - if creator is null

getPropertyName

protected String getPropertyName(MethodAnnotationScanner.MethodInfo methodInfo)

Get the property name from the annotation.

Parameters:

methodInfo - method info

Returns:

property name

getType

public Class<T> getType()

Get the type associated with this instance.

Returns:

backing object type

getColumnMap

public Map<String,MethodAnnotationScanner.MethodInfo> getColumnMap()

Get the annotations found through introspection keyed by property name.

Returns:

columns keyed by property name and sorted based on GridColumn.order(), then property name