JavaFX 25 · javafx.beans.property.adapter.ReadOnlyJavaBeanStringPropertyBuilder

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

Modifier and Type	Field and Description
private final ReadOnlyJavaBeanPropertyBuilderHelper<String>	helper

Access	Constructor and Description
private	ReadOnlyJavaBeanStringPropertyBuilder()

Method Summary

Modifier and Type	Method and Description
public ReadOnlyJavaBeanStringPropertyBuilder	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 ReadOnlyJavaBeanStringPropertyBuilder	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 ReadOnlyJavaBeanStringProperty	Returns: the new `ReadOnlyJavaBeanStringProperty` build() Generate a new `ReadOnlyJavaBeanStringProperty` with the current settings.
public static ReadOnlyJavaBeanStringPropertyBuilder	Returns: the new `ReadOnlyJavaBeanStringPropertyBuilder` create() Create a new instance of `ReadOnlyJavaBeanStringPropertyBuilder`
public ReadOnlyJavaBeanStringPropertyBuilder	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 ReadOnlyJavaBeanStringPropertyBuilder	Returns: a reference to this builder to enable method chaining getter(Method the getter getter) Set the getter method directly.
public ReadOnlyJavaBeanStringPropertyBuilder	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:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

helper	back to summary
private final ReadOnlyJavaBeanPropertyBuilderHelper<String> helper

Constructor Detail

ReadOnlyJavaBeanStringPropertyBuilder	back to summary
private ReadOnlyJavaBeanStringPropertyBuilder()

Method Detail

bean	back to summary
public ReadOnlyJavaBeanStringPropertyBuilder bean(Object bean) Set the Java Bean instance the adapter should connect to Parameters bean:Object the Java Bean instance Returns:ReadOnlyJavaBeanStringPropertyBuilder a reference to this builder to enable method chaining

bean

back to summary

public ReadOnlyJavaBeanStringPropertyBuilder bean(Object bean)

Set the Java Bean instance the adapter should connect to

Parameters

bean:Object: the Java Bean instance

Returns:ReadOnlyJavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

beanClass	back to summary
public ReadOnlyJavaBeanStringPropertyBuilder 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:ReadOnlyJavaBeanStringPropertyBuilder a reference to this builder to enable method chaining

beanClass

back to summary

public ReadOnlyJavaBeanStringPropertyBuilder 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:ReadOnlyJavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

build back to summary

build	back to summary
public ReadOnlyJavaBeanStringProperty build() throws NoSuchMethodException Generate a new `ReadOnlyJavaBeanStringProperty` with the current settings. Returns:ReadOnlyJavaBeanStringProperty the new `ReadOnlyJavaBeanStringProperty` Exceptions 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 `String`

public ReadOnlyJavaBeanStringProperty build() throws NoSuchMethodException

Generate a new ReadOnlyJavaBeanStringProperty with the current settings.

Returns:ReadOnlyJavaBeanStringProperty

the new ReadOnlyJavaBeanStringProperty

Exceptions

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 String

create back to summary

create	back to summary
public static ReadOnlyJavaBeanStringPropertyBuilder create() Create a new instance of `ReadOnlyJavaBeanStringPropertyBuilder` Returns:ReadOnlyJavaBeanStringPropertyBuilder the new `ReadOnlyJavaBeanStringPropertyBuilder`

public static ReadOnlyJavaBeanStringPropertyBuilder create()

Create a new instance of ReadOnlyJavaBeanStringPropertyBuilder

Returns:ReadOnlyJavaBeanStringPropertyBuilder: the new ReadOnlyJavaBeanStringPropertyBuilder

getter	back to summary
public ReadOnlyJavaBeanStringPropertyBuilder 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:ReadOnlyJavaBeanStringPropertyBuilder a reference to this builder to enable method chaining

getter

back to summary

public ReadOnlyJavaBeanStringPropertyBuilder 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:ReadOnlyJavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

getter	back to summary
public ReadOnlyJavaBeanStringPropertyBuilder 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:ReadOnlyJavaBeanStringPropertyBuilder a reference to this builder to enable method chaining

getter

back to summary

public ReadOnlyJavaBeanStringPropertyBuilder 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:ReadOnlyJavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

name	back to summary
public ReadOnlyJavaBeanStringPropertyBuilder name(String name) Set the name of the property Parameters name:String the name of the property Returns:ReadOnlyJavaBeanStringPropertyBuilder a reference to this builder to enable method chaining

name

back to summary

public ReadOnlyJavaBeanStringPropertyBuilder name(String name)

Set the name of the property

Parameters

name:String: the name of the property

Returns:ReadOnlyJavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

public final Class ReadOnlyJavaBeanStringPropertyBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail