Module javafx.base

Package javafx.beans.property.adapter

Class ReadOnlyJavaBeanBooleanPropertyBuilder

java.lang.Object

javafx.beans.property.adapter.ReadOnlyJavaBeanBooleanPropertyBuilder

public final class ReadOnlyJavaBeanBooleanPropertyBuilder
extends Object

A ReadOnlyJavaBeanBooleanPropertyBuilder can be used to create ReadOnlyJavaBeanBooleanProperties. To create a ReadOnlyJavaBeanBooleanProperty 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 ReadOnlyJavaBeanBooleanPropertyBuilder. by switching the Java Bean instance (with bean(java.lang.Object) and calling build().

Since:

JavaFX 2.1

See Also:

ReadOnlyJavaBeanBooleanProperty

Constructor Summary

Constructors

Constructor	Description
ReadOnlyJavaBeanBooleanPropertyBuilder()

Method Summary

Modifier and Type	Method	Description
ReadOnlyJavaBeanBooleanPropertyBuilder	bean(Object bean)	Set the Java Bean instance the adapter should connect to
ReadOnlyJavaBeanBooleanPropertyBuilder	beanClass(Class<?> beanClass)	Set the Java Bean class in which the getter should be searched.
ReadOnlyJavaBeanBooleanProperty	build()	Generate a new ReadOnlyJavaBeanBooleanProperty with the current settings.
static ReadOnlyJavaBeanBooleanPropertyBuilder	create()	Create a new instance of ReadOnlyJavaBeanBooleanPropertyBuilder
ReadOnlyJavaBeanBooleanPropertyBuilder	getter(Method getter)	Set the getter method directly.
ReadOnlyJavaBeanBooleanPropertyBuilder	getter(String getter)	Set an alternative name for the getter.
ReadOnlyJavaBeanBooleanPropertyBuilder	name(String name)	Set the name of the property

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadOnlyJavaBeanBooleanPropertyBuilder

public ReadOnlyJavaBeanBooleanPropertyBuilder()

Method Detail

create

public static ReadOnlyJavaBeanBooleanPropertyBuilder create()

Create a new instance of ReadOnlyJavaBeanBooleanPropertyBuilder

Returns:

the new ReadOnlyJavaBeanBooleanPropertyBuilder

build

public ReadOnlyJavaBeanBooleanProperty build()
                                      throws NoSuchMethodException

Generate a new ReadOnlyJavaBeanBooleanProperty with the current settings.

Returns:

the new ReadOnlyJavaBeanBooleanProperty

Throws:

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

IllegalArgumentException - if the Java Bean property is not of type boolean or Boolean

name

public ReadOnlyJavaBeanBooleanPropertyBuilder name(String name)

Set the name of the property

Parameters:

name - the name of the property

Returns:

a reference to this builder to enable method chaining

bean

public ReadOnlyJavaBeanBooleanPropertyBuilder bean(Object bean)

Set 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 ReadOnlyJavaBeanBooleanPropertyBuilder 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 - the Java Bean class

Returns:

a reference to this builder to enable method chaining

getter

public ReadOnlyJavaBeanBooleanPropertyBuilder 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 - the alternative name of the getter

Returns:

a reference to this builder to enable method chaining

getter

public ReadOnlyJavaBeanBooleanPropertyBuilder 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 - the getter

Returns:

a reference to this builder to enable method chaining