javafx.beans.property.adapter

Class JavaBeanStringPropertyBuilder

java.lang.Object

javafx.beans.property.adapter.JavaBeanStringPropertyBuilder

public final class JavaBeanStringPropertyBuilder
extends Object

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().

Since:

JavaFX 2.1

Constructors
Constructor and Description
`JavaBeanStringPropertyBuilder()`

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- JavaBeanStringPropertyBuilder
```
public JavaBeanStringPropertyBuilder()
```

Method Detail
- create
```
public static JavaBeanStringPropertyBuilder create()
```
  Create a new instance of JavaBeanStringPropertyBuilder
  
  Returns:
  
  the new JavaBeanStringPropertyBuilder
- build
```
public JavaBeanStringProperty build()
                             throws NoSuchMethodException
```
  Generate a new JavaBeanStringProperty with the current settings.
  
  Returns:
  
  the new JavaBeanStringProperty
  
  Throws:
  
  NoSuchMethodException - if the settings were not sufficient to find the getter and the setter of the Java Bean property
- name
```
public JavaBeanStringPropertyBuilder 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 JavaBeanStringPropertyBuilder 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 JavaBeanStringPropertyBuilder beanClass(Class<?> beanClass)
```
  Set 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 - the Java Bean class
  
  Returns:
  
  a reference to this builder to enable method chaining
- getter
```
public JavaBeanStringPropertyBuilder 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
- setter
```
public JavaBeanStringPropertyBuilder setter(String setter)
```
  Set an alternative name for the setter. This can be omitted, if the name of the setter follows Java Bean naming conventions.
  
  Parameters:
  
  setter - the alternative name of the setter
  
  Returns:
  
  a reference to this builder to enable method chaining
- getter
```
public JavaBeanStringPropertyBuilder 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
- setter
```
public JavaBeanStringPropertyBuilder setter(Method setter)
```
  Set the setter method directly. This can be omitted, if the name of the setter follows Java Bean naming conventions.
  
  Parameters:
  
  setter - the setter
  
  Returns:
  
  a reference to this builder to enable method chaining

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Class JavaBeanStringPropertyBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JavaBeanStringPropertyBuilder

Method Detail

create

build

name

bean

beanClass

getter

setter

getter

setter