javafx.beans.property.adapter

Class ReadOnlyJavaBeanLongPropertyBuilder

java.lang.Object

javafx.beans.property.adapter.ReadOnlyJavaBeanLongPropertyBuilder

public final class ReadOnlyJavaBeanLongPropertyBuilder
extends Object

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

Since:

JavaFX 2.1

See Also:

ReadOnlyJavaBeanLongProperty

Constructor Summary

Constructors

Constructor and Description
ReadOnlyJavaBeanLongPropertyBuilder()

Method Summary

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

ReadOnlyJavaBeanLongPropertyBuilder

public ReadOnlyJavaBeanLongPropertyBuilder()

Method Detail

create

public static ReadOnlyJavaBeanLongPropertyBuilder create()

Create a new instance of ReadOnlyJavaBeanLongPropertyBuilder

Returns:

the new ReadOnlyJavaBeanLongPropertyBuilder

build

public ReadOnlyJavaBeanLongProperty build()
                                   throws NoSuchMethodException

Generate a new ReadOnlyJavaBeanLongProperty with the current settings.

Returns:

the new ReadOnlyJavaBeanLongProperty

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 long or Long

name

public ReadOnlyJavaBeanLongPropertyBuilder 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 ReadOnlyJavaBeanLongPropertyBuilder 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 ReadOnlyJavaBeanLongPropertyBuilder 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 ReadOnlyJavaBeanLongPropertyBuilder 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 ReadOnlyJavaBeanLongPropertyBuilder 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