Module javafx.base

Package javafx.beans.property.adapter

Class JavaBeanObjectPropertyBuilder<T>

java.lang.Object

javafx.beans.property.adapter.JavaBeanObjectPropertyBuilder<T>

public final class JavaBeanObjectPropertyBuilder<T>
extends Object

A JavaBeanObjectPropertyBuilder can be used to create JavaBeanObjectProperties. To create a JavaBeanObjectProperty one first has to call create() to generate a builder, set the required properties, and then one can call build() to generate the property.

Not all properties of a builder have to specified, there are several combinations possible. As a minimum the name(java.lang.String) of the property and the bean(java.lang.Object) have to be specified. If the names of the getter and setter follow the conventions, this is sufficient. Otherwise it is possible to specify an alternative name for the getter and setter (getter(java.lang.String) and setter(java.lang.String)) or the getter and setter Methods directly (getter(java.lang.reflect.Method) and setter(java.lang.reflect.Method)).

All methods to change properties return a reference to this builder, to enable method chaining.

If you have to generate adapters for the same property of several instances of the same class, you can reuse a JavaBeanObjectPropertyBuilder by switching the Java Bean instance (with bean(java.lang.Object) and calling build().

Since:

JavaFX 2.1

See Also:

JavaBeanObjectProperty

Constructor Summary

Constructors

Constructor	Description
JavaBeanObjectPropertyBuilder()	Do not use this constructor. It will be deprecated in the next version.

Method Summary

Modifier and Type	Method	Description
JavaBeanObjectPropertyBuilder	bean(Object bean)	Sets the Java Bean instance the adapter should connect to.
JavaBeanObjectPropertyBuilder	beanClass(Class<?> beanClass)	Sets the Java Bean class in which the getter and setter should be searched.
JavaBeanObjectProperty<T>	build()	Generates a new JavaBeanObjectProperty with the current settings.
static JavaBeanObjectPropertyBuilder	create()	Creates a new instance of JavaBeanObjectPropertyBuilder.
JavaBeanObjectPropertyBuilder	getter(Method getter)	Sets the getter method directly.
JavaBeanObjectPropertyBuilder	getter(String getter)	Sets an alternative name for the getter.
JavaBeanObjectPropertyBuilder	name(String name)	Sets the name of the property.
JavaBeanObjectPropertyBuilder	setter(Method setter)	Sets the setter method directly.
JavaBeanObjectPropertyBuilder	setter(String setter)	Sets an alternative name for the setter.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaBeanObjectPropertyBuilder

public JavaBeanObjectPropertyBuilder()

Do not use this constructor. It will be deprecated in the next version. Use create() instead.

Method Detail

create

public static JavaBeanObjectPropertyBuilder create()

Creates a new instance of JavaBeanObjectPropertyBuilder.

Returns:

the new JavaBeanObjectPropertyBuilder

build

public JavaBeanObjectProperty<T> build()
                                throws NoSuchMethodException

Generates a new JavaBeanObjectProperty with the current settings.

Returns:

the new JavaBeanObjectProperty

Throws:

NoSuchMethodException - if the settings were not sufficient to find the getter and the setter of the Java Bean property

name

public JavaBeanObjectPropertyBuilder name(String name)

Sets the name of the property.

Parameters:

name - the name of the property

Returns:

a reference to this builder to enable method chaining

bean

public JavaBeanObjectPropertyBuilder bean(Object bean)

Sets the Java Bean instance the adapter should connect to.

Parameters:

bean - the Java Bean instance

Returns:

a reference to this builder to enable method chaining

beanClass

public JavaBeanObjectPropertyBuilder beanClass(Class<?> beanClass)

Sets the Java Bean class in which the getter and setter should be searched. This can be useful if the builder should generate adapters for several Java Beans of different types.

Parameters:

beanClass - the Java Bean class

Returns:

a reference to this builder to enable method chaining

getter

public JavaBeanObjectPropertyBuilder getter(String getter)

Sets an alternative name for the getter. This can be omitted if the name of the getter follows Java Bean naming conventions.

Parameters:

getter - the alternative name of the getter

Returns:

a reference to this builder to enable method chaining

setter

public JavaBeanObjectPropertyBuilder setter(String setter)

Sets an alternative name for the setter. This can be omitted if the name of the setter follows Java Bean naming conventions.

Parameters:

setter - the alternative name of the setter

Returns:

a reference to this builder to enable method chaining

getter

public JavaBeanObjectPropertyBuilder getter(Method getter)

Sets the getter method directly. This can be omitted if the name of the getter follows Java Bean naming conventions.

Parameters:

getter - the getter

Returns:

a reference to this builder to enable method chaining

setter

public JavaBeanObjectPropertyBuilder setter(Method setter)

Sets the setter method directly. This can be omitted if the name of the setter follows Java Bean naming conventions.

Parameters:

setter - the setter

Returns:

a reference to this builder to enable method chaining