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

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

Modifier and Type	Field and Description
private JavaBeanPropertyBuilderHelper<String>	helper

Access	Constructor and Description
private	JavaBeanStringPropertyBuilder()

Method Summary

Modifier and Type	Method and Description
public JavaBeanStringPropertyBuilder	Returns: a reference to this builder to enable method chaining bean(Object the Java Bean instance bean) Sets the Java Bean instance the adapter should connect to.
public JavaBeanStringPropertyBuilder	Returns: a reference to this builder to enable method chaining beanClass(Class<?> the Java Bean class beanClass) Sets the Java Bean class in which the getter and setter should be searched.
public JavaBeanStringProperty	Returns: the new `JavaBeanStringProperty` build() Generates a new `JavaBeanStringProperty` with the current settings.
public static JavaBeanStringPropertyBuilder	Returns: the new `JavaBeanStringPropertyBuilder` create() Creates a new instance of `JavaBeanStringPropertyBuilder`.
public JavaBeanStringPropertyBuilder	Returns: a reference to this builder to enable method chaining getter(String the alternative name of the getter getter) Sets an alternative name for the getter.
public JavaBeanStringPropertyBuilder	Returns: a reference to this builder to enable method chaining getter(Method the getter getter) Sets the getter method directly.
public JavaBeanStringPropertyBuilder	Returns: a reference to this builder to enable method chaining name(String the name of the property name) Sets the name of the property.
public JavaBeanStringPropertyBuilder	Returns: a reference to this builder to enable method chaining setter(String the alternative name of the setter setter) Sets an alternative name for the setter.
public JavaBeanStringPropertyBuilder	Returns: a reference to this builder to enable method chaining setter(Method the setter setter) Sets the setter method directly.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

helper	back to summary
private JavaBeanPropertyBuilderHelper<String> helper

Constructor Detail

JavaBeanStringPropertyBuilder	back to summary
private JavaBeanStringPropertyBuilder()

Method Detail

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

bean

back to summary

public JavaBeanStringPropertyBuilder bean(Object bean)

Sets the Java Bean instance the adapter should connect to.

Parameters

bean:Object: the Java Bean instance

Returns:JavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

beanClass	back to summary
public JavaBeanStringPropertyBuilder 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:Class<?> the Java Bean class Returns:JavaBeanStringPropertyBuilder a reference to this builder to enable method chaining

beanClass

back to summary

public JavaBeanStringPropertyBuilder 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:Class<?>: the Java Bean class

Returns:JavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

build back to summary

build	back to summary
public JavaBeanStringProperty build() throws NoSuchMethodException Generates a new `JavaBeanStringProperty` with the current settings. Returns:JavaBeanStringProperty the new `JavaBeanStringProperty` Exceptions NoSuchMethodException: if the settings were not sufficient to find the getter and the setter of the Java Bean property IllegalArgumentException: if the Java Bean property is not of type `String`

public JavaBeanStringProperty build() throws NoSuchMethodException

Generates a new JavaBeanStringProperty with the current settings.

Returns:JavaBeanStringProperty

the new JavaBeanStringProperty

Exceptions

NoSuchMethodException:: if the settings were not sufficient to find the getter and the setter 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 JavaBeanStringPropertyBuilder create() Creates a new instance of `JavaBeanStringPropertyBuilder`. Returns:JavaBeanStringPropertyBuilder the new `JavaBeanStringPropertyBuilder`

public static JavaBeanStringPropertyBuilder create()

Creates a new instance of JavaBeanStringPropertyBuilder.

Returns:JavaBeanStringPropertyBuilder: the new JavaBeanStringPropertyBuilder

getter	back to summary
public JavaBeanStringPropertyBuilder 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:String the alternative name of the getter Returns:JavaBeanStringPropertyBuilder a reference to this builder to enable method chaining

getter

back to summary

public JavaBeanStringPropertyBuilder 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:String: the alternative name of the getter

Returns:JavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

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

getter

back to summary

public JavaBeanStringPropertyBuilder 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:Method: the getter

Returns:JavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

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

name

back to summary

public JavaBeanStringPropertyBuilder name(String name)

Sets the name of the property.

Parameters

name:String: the name of the property

Returns:JavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

setter	back to summary
public JavaBeanStringPropertyBuilder 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:String the alternative name of the setter Returns:JavaBeanStringPropertyBuilder a reference to this builder to enable method chaining

setter

back to summary

public JavaBeanStringPropertyBuilder 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:String: the alternative name of the setter

Returns:JavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

setter	back to summary
public JavaBeanStringPropertyBuilder 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:Method the setter Returns:JavaBeanStringPropertyBuilder a reference to this builder to enable method chaining

setter

back to summary

public JavaBeanStringPropertyBuilder 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:Method: the setter

Returns:JavaBeanStringPropertyBuilder

a reference to this builder to enable method chaining

public final Class JavaBeanStringPropertyBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail