Top Description Fields Constructors Methods
javafx.beans.property.adapter

public final Class ReadOnlyJavaBeanObjectPropertyBuilder<T>

extends Object
Class Inheritance
Type Parameters
<T>
the type of the wrapped Object
Imports
com.sun.javafx.property.adapter.ReadOnlyJavaBeanPropertyBuilderHelper, .ReadOnlyPropertyDescriptor, java.lang.reflect.Method
A ReadOnlyJavaBeanObjectPropertyBuilder can be used to create ReadOnlyJavaBeanObjectProperties. To create a ReadOnlyJavaBeanObjectProperty 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 name of the getter follows the conventions, this is sufficient. Otherwise it is possible to specify an alternative name for the getter (getter(java.lang.String)) or the getter Methods directly (getter(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 ReadOnlyJavaBeanObjectPropertyBuilder. by switching the Java Bean instance (with bean(java.lang.Object) and calling build().

Since
JavaFX 2.1
See Also
ReadOnlyJavaBeanObjectProperty

Field Summary

Modifier and TypeField and Description
private final ReadOnlyJavaBeanPropertyBuilderHelper<T>
helper

Constructor Summary

AccessConstructor and Description
private
ReadOnlyJavaBeanObjectPropertyBuilder()

Method Summary

Modifier and TypeMethod and Description
public ReadOnlyJavaBeanObjectPropertyBuilder<T>

Returns:

a reference to this builder to enable method chaining
bean(Object
the Java Bean instance
bean)

Set the Java Bean instance the adapter should connect to

public ReadOnlyJavaBeanObjectPropertyBuilder<T>

Returns:

a reference to this builder to enable method chaining
beanClass(Class<?>
the Java Bean class
beanClass)

Set the Java Bean class in which the getter should be searched.

public ReadOnlyJavaBeanObjectProperty<T>

Returns:

the new ReadOnlyJavaBeanObjectProperty
build()

Generate a new ReadOnlyJavaBeanObjectProperty with the current settings.

public static <
the type of the wrapped Object
T> ReadOnlyJavaBeanObjectPropertyBuilder<T>

Returns:

the new ReadOnlyJavaBeanObjectPropertyBuilder
create()

Create a new instance of ReadOnlyJavaBeanObjectPropertyBuilder

public ReadOnlyJavaBeanObjectPropertyBuilder<T>

Returns:

a reference to this builder to enable method chaining
getter(String
the alternative name of the getter
getter)

Set an alternative name for the getter.

public ReadOnlyJavaBeanObjectPropertyBuilder<T>

Returns:

a reference to this builder to enable method chaining
getter(Method
the getter
getter)

Set the getter method directly.

public ReadOnlyJavaBeanObjectPropertyBuilder<T>

Returns:

a reference to this builder to enable method chaining
name(String
the name of the property
name)

Set the name of the property

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

helperback to summary
private final ReadOnlyJavaBeanPropertyBuilderHelper<T> helper

Constructor Detail

ReadOnlyJavaBeanObjectPropertyBuilderback to summary
private ReadOnlyJavaBeanObjectPropertyBuilder()

Method Detail

beanback to summary
public ReadOnlyJavaBeanObjectPropertyBuilder<T> bean(Object bean)

Set the Java Bean instance the adapter should connect to

Parameters
bean:Object

the Java Bean instance

Returns:ReadOnlyJavaBeanObjectPropertyBuilder<T>

a reference to this builder to enable method chaining

beanClassback to summary
public ReadOnlyJavaBeanObjectPropertyBuilder<T> beanClass(Class<?> beanClass)

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

Parameters
beanClass:Class<?>

the Java Bean class

Returns:ReadOnlyJavaBeanObjectPropertyBuilder<T>

a reference to this builder to enable method chaining

buildback to summary
public ReadOnlyJavaBeanObjectProperty<T> build() throws NoSuchMethodException

Generate a new ReadOnlyJavaBeanObjectProperty with the current settings.

Returns:ReadOnlyJavaBeanObjectProperty<T>

the new ReadOnlyJavaBeanObjectProperty

Exceptions
NoSuchMethodException:
if the settings were not sufficient to find the getter of the Java Bean property
createback to summary
public static <T> ReadOnlyJavaBeanObjectPropertyBuilder<T> create()

Create a new instance of ReadOnlyJavaBeanObjectPropertyBuilder

Parameters
<T>
the type of the wrapped Object
Returns:ReadOnlyJavaBeanObjectPropertyBuilder<T>

the new ReadOnlyJavaBeanObjectPropertyBuilder

getterback to summary
public ReadOnlyJavaBeanObjectPropertyBuilder<T> getter(String getter)

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

Parameters
getter:String

the alternative name of the getter

Returns:ReadOnlyJavaBeanObjectPropertyBuilder<T>

a reference to this builder to enable method chaining

getterback to summary
public ReadOnlyJavaBeanObjectPropertyBuilder<T> getter(Method getter)

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

Parameters
getter:Method

the getter

Returns:ReadOnlyJavaBeanObjectPropertyBuilder<T>

a reference to this builder to enable method chaining

nameback to summary
public ReadOnlyJavaBeanObjectPropertyBuilder<T> name(String name)

Set the name of the property

Parameters
name:String

the name of the property

Returns:ReadOnlyJavaBeanObjectPropertyBuilder<T>

a reference to this builder to enable method chaining