JavaFX 24 · com.sun.javafx.fxml.BeanAdapter · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	BeanAdapter.MethodCache

Modifier and Type	Field and Description
private final Object	bean
public static final String	GET_PREFIX
private static final HashMap<Class<?>, BeanAdapter.MethodCache>	globalMethodCache
public static final String	IS_PREFIX
private final BeanAdapter.MethodCache	localCache
public static final String	PROPERTY_SUFFIX
public static final String	SET_PREFIX
public static final String	VALUE_OF_METHOD_NAME

Access	Constructor and Description
public	BeanAdapter(Object The Bean object to wrap. bean) Creates a new Bean adapter.

Method Summary

Modifier and Type	Method and Description
public static <T> T	Returns: The coerced value. coerce(Object value, Class<? extends T> type) Coerces a value to a given type.
public boolean	Returns: `true` if the property exists; `false`, otherwise. containsKey(Object The property name. key) Overrides java.util.AbstractMap.containsKey. Implements java.util.Map.containsKey. Verifies the existence of a property.
public Set<Map.Entry<String, Object>>	entrySet() Implements abstract java.util.AbstractMap.entrySet. Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.
public boolean	equals(Object object to be compared for equality with this map object) Overrides java.util.AbstractMap.equals. Implements java.util.Map.equals. Compares the specified object with this map for equality.
public Object	Returns: The value returned by the method, or `null` if no such method exists. get(Object The property name. key) Overrides java.util.AbstractMap.get. Implements java.util.Map.get. Invokes the getter method for the given property.
private Object	get(String key)
public static <T> T	Returns: The value returned by the method, or `null` if no such method exists. get(Object The object to which the property is attached. target, Class<?> The class that defines the property. sourceType, String The property name. key) Invokes the static getter method for the given property.
public Object	Returns: The Bean object, or `null` if no Bean has been set. getBean() Returns the Bean object this adapter wraps.
private static BeanAdapter.MethodCache	getClassMethodCache(final Class<?> type)
public static Object	getConstantValue(Class<?> The type that defines the constant. type, String The name of the constant. name) Returns the value of a named constant.
public static Type	getGenericListItemType(Type listType) Determines the type of a list item.
public static Type	getGenericMapValueType(Type mapType) Determines the type of a map value.
public Type	getGenericType(String The property name. key) Returns the generic type of a property.
public static Type	getGenericType(Class<?> The class that defines the property. sourceType, String The property name. key, Class<?> The type of the object to which the property applies. targetType) Returns the generic type of a static property.
private Method	getGetterMethod(String key)
public static Class<?>	getListItemType(Type listType) Determines the type of a list item.
public static Class<?>	getMapValueType(Type mapType) Determines the type of a map value.
private static String	getMethodName(String prefix, String key)
public <T> ObservableValue<T>	Returns: The named property model, or `null` if no such property exists. getPropertyModel(String The property name. key) Returns the property model for the given property.
private Method	getSetterMethod(String key)
private static Method	getStaticGetterMethod(Class<?> sourceType, String key, Class<?> targetType)
private static Method	getStaticSetterMethod(Class<?> sourceType, String key, Class<?> valueType, Class<?> targetType)
public Class<?>	getType(String The property name. key) Returns the type of a property.
public static Class<?>	getType(Class<?> The class that defines the property. sourceType, String The property name. key, Class<?> The type of the object to which the property applies. targetType) Returns the type of a static property.
public int	hashCode() Overrides java.util.AbstractMap.hashCode. Implements java.util.Map.hashCode. Returns the hash code value for this map.
public static boolean	Returns: `true` if the property exists; `false`, otherwise. isDefined(Class<?> The class that defines the property. sourceType, String The property name. key, Class<?> The type of the object to which the property applies. targetType) Tests the existence of a static property.
public boolean	Returns: `true` if the property is read-only; `false`, otherwise. isReadOnly(String The property name. key) Tests the mutability of a property.
public Object	Returns: Returns `null`, since returning the previous value would require an unnecessary call to the getter method. put(String The property name. key, Object The new property value. value) Overrides java.util.AbstractMap.put. Implements java.util.Map.put. Invokes a setter method for the given property.
public static void	put(Object The object to which the property is or will be attached. target, Class<?> The class that defines the property. sourceType, String The property name. key, Object The new property value. value) Invokes a static setter method for the given property.
private static String	toAllCaps(String value)

Inherited from java.util.AbstractMap:: clear clone containsValue isEmpty keySet putAll remove size toString values

bean	back to summary
private final Object bean

GET_PREFIX	back to summary
public static final String GET_PREFIX

globalMethodCache	back to summary
private static final HashMap<Class<?>, BeanAdapter.MethodCache> globalMethodCache

IS_PREFIX	back to summary
public static final String IS_PREFIX

localCache	back to summary
private final BeanAdapter.MethodCache localCache

PROPERTY_SUFFIX	back to summary
public static final String PROPERTY_SUFFIX

SET_PREFIX	back to summary
public static final String SET_PREFIX

VALUE_OF_METHOD_NAME	back to summary
public static final String VALUE_OF_METHOD_NAME

BeanAdapter	back to summary
public BeanAdapter(Object bean) Creates a new Bean adapter. Parameters bean:Object The Bean object to wrap.

Method Detail

coerce	back to summary
public static <T> T coerce(Object value, Class<? extends T> type) Coerces a value to a given type. Returns:T The coerced value. Annotations @SuppressWarnings:unchecked

coerce

back to summary

public static <T> T coerce(Object value, Class<? extends T> type)

Coerces a value to a given type.

Returns:T

The coerced value.

Annotations

@SuppressWarnings:unchecked

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Overrides java.util.AbstractMap.containsKey. Implements java.util.Map.containsKey. Verifies the existence of a property. Parameters key:Object The property name. Returns:boolean `true` if the property exists; `false`, otherwise. Annotations @Override

public boolean containsKey(Object key)

Overrides java.util.AbstractMap.containsKey.

Implements java.util.Map.containsKey.

Verifies the existence of a property.

Parameters

key:Object: The property name.

Returns:boolean

true if the property exists; false, otherwise.

Annotations

@Override

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<String, Object>> entrySet() Implements abstract java.util.AbstractMap.entrySet. Implements java.util.Map.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation, or through the `setValue` operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<Map.Entry<String, Object>> a set view of the mappings contained in this map Annotations @Override

public Set<Map.Entry<String, Object>> entrySet()

Implements abstract java.util.AbstractMap.entrySet.

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<Map.Entry<String, Object>>

a set view of the mappings contained in this map

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.util.AbstractMap.equals. Implements java.util.Map.equals. Doc from java.util.AbstractMap.equals. Compares the specified object with this map for equality. Returns `true` if the given object is also a map and the two maps represent the same mappings. More formally, two maps `m1` and `m2` represent the same mappings if `m1.entrySet().equals(m2.entrySet())`. This ensures that the `equals` method works properly across different implementations of the `Map` interface. Parameters object:Object object to be compared for equality with this map Returns:boolean `true` if the specified object is equal to this map Annotations @Override

public boolean equals(Object object)

Overrides java.util.AbstractMap.equals.

Implements java.util.Map.equals.

Doc from java.util.AbstractMap.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Parameters

object:Object: object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to this map

Annotations

@Override

get back to summary

get	back to summary
public Object get(Object key) Overrides java.util.AbstractMap.get. Implements java.util.Map.get. Invokes the getter method for the given property. Parameters key:Object The property name. Returns:Object The value returned by the method, or `null` if no such method exists. Annotations @Override

public Object get(Object key)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

Invokes the getter method for the given property.

Parameters

key:Object: The property name.

Returns:Object

The value returned by the method, or null if no such method exists.

Annotations

@Override

get	back to summary
private Object get(String key)

get back to summary

get	back to summary
public static <T> T get(Object target, Class<?> sourceType, String key) Invokes the static getter method for the given property. Parameters target:Object The object to which the property is attached. sourceType:Class<?> The class that defines the property. key:String The property name. Returns:T The value returned by the method, or `null` if no such method exists. Annotations @SuppressWarnings:unchecked

public static <T> T get(Object target, Class<?> sourceType, String key)

Invokes the static getter method for the given property.

Parameters

target:Object: The object to which the property is attached.
sourceType:Class<?>: The class that defines the property.
key:String: The property name.

Returns:T

The value returned by the method, or null if no such method exists.

Annotations

@SuppressWarnings:unchecked

getBean back to summary

getBean	back to summary
public Object getBean() Returns the Bean object this adapter wraps. Returns:Object The Bean object, or `null` if no Bean has been set.

public Object getBean()

Returns the Bean object this adapter wraps.

Returns:Object: The Bean object, or null if no Bean has been set.

getClassMethodCache	back to summary
private static BeanAdapter.MethodCache getClassMethodCache(final Class<?> type)

getConstantValue	back to summary
public static Object getConstantValue(Class<?> type, String name) Returns the value of a named constant. Parameters type:Class<?> The type that defines the constant. name:String The name of the constant.

getConstantValue

back to summary

public static Object getConstantValue(Class<?> type, String name)

Returns the value of a named constant.

Parameters

type:Class<?>: The type that defines the constant.
name:String: The name of the constant.

getGenericListItemType	back to summary
public static Type getGenericListItemType(Type listType) Determines the type of a list item.

getGenericMapValueType	back to summary
public static Type getGenericMapValueType(Type mapType) Determines the type of a map value.

getGenericType	back to summary
public Type getGenericType(String key) Returns the generic type of a property. Parameters key:String The property name.

getGenericType

back to summary

public Type getGenericType(String key)

Returns the generic type of a property.

Parameters

key:String: The property name.

getGenericType	back to summary
public static Type getGenericType(Class<?> sourceType, String key, Class<?> targetType) Returns the generic type of a static property. Parameters sourceType:Class<?> The class that defines the property. key:String The property name. targetType:Class<?> The type of the object to which the property applies.

getGenericType

back to summary

public static Type getGenericType(Class<?> sourceType, String key, Class<?> targetType)

Returns the generic type of a static property.

Parameters

sourceType:Class<?>: The class that defines the property.
key:String: The property name.
targetType:Class<?>: The type of the object to which the property applies.

getGetterMethod	back to summary
private Method getGetterMethod(String key)

getListItemType	back to summary
public static Class<?> getListItemType(Type listType) Determines the type of a list item.

getMapValueType	back to summary
public static Class<?> getMapValueType(Type mapType) Determines the type of a map value.

getMethodName	back to summary
private static String getMethodName(String prefix, String key)

getPropertyModel back to summary

getPropertyModel	back to summary
public <T> ObservableValue<T> getPropertyModel(String key) Returns the property model for the given property. Parameters key:String The property name. Returns:ObservableValue<T> The named property model, or `null` if no such property exists. Annotations @SuppressWarnings:unchecked

public <T> ObservableValue<T> getPropertyModel(String key)

Returns the property model for the given property.

Parameters

key:String: The property name.

Returns:ObservableValue<T>

The named property model, or null if no such property exists.

Annotations

@SuppressWarnings:unchecked

getSetterMethod	back to summary
private Method getSetterMethod(String key)

getStaticGetterMethod	back to summary
private static Method getStaticGetterMethod(Class<?> sourceType, String key, Class<?> targetType)

getStaticSetterMethod	back to summary
private static Method getStaticSetterMethod(Class<?> sourceType, String key, Class<?> valueType, Class<?> targetType)

getType	back to summary
public Class<?> getType(String key) Returns the type of a property. Parameters key:String The property name.

getType

back to summary

public Class<?> getType(String key)

Returns the type of a property.

Parameters

key:String: The property name.

getType	back to summary
public static Class<?> getType(Class<?> sourceType, String key, Class<?> targetType) Returns the type of a static property. Parameters sourceType:Class<?> The class that defines the property. key:String The property name. targetType:Class<?> The type of the object to which the property applies.

getType

back to summary

public static Class<?> getType(Class<?> sourceType, String key, Class<?> targetType)

Returns the type of a static property.

Parameters

sourceType:Class<?>: The class that defines the property.
key:String: The property name.
targetType:Class<?>: The type of the object to which the property applies.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.util.AbstractMap.hashCode. Implements java.util.Map.hashCode. Doc from java.util.AbstractMap.hashCode. Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's `entrySet()` view. This ensures that `m1.equals(m2)` implies that `m1.hashCode()==m2.hashCode()` for any two maps `m1` and `m2`, as required by the general contract of `Object#hashCode`. Returns:int the hash code value for this map Annotations @Override

public int hashCode()

Overrides java.util.AbstractMap.hashCode.

Implements java.util.Map.hashCode.

Doc from java.util.AbstractMap.hashCode.

Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this map

Annotations

@Override

isDefined back to summary

isDefined	back to summary
public static boolean isDefined(Class<?> sourceType, String key, Class<?> targetType) Tests the existence of a static property. Parameters sourceType:Class<?> The class that defines the property. key:String The property name. targetType:Class<?> The type of the object to which the property applies. Returns:boolean `true` if the property exists; `false`, otherwise.

public static boolean isDefined(Class<?> sourceType, String key, Class<?> targetType)

Tests the existence of a static property.

Parameters

sourceType:Class<?>: The class that defines the property.
key:String: The property name.
targetType:Class<?>: The type of the object to which the property applies.

Returns:boolean

true if the property exists; false, otherwise.

isReadOnly back to summary

isReadOnly	back to summary
public boolean isReadOnly(String key) Tests the mutability of a property. Parameters key:String The property name. Returns:boolean `true` if the property is read-only; `false`, otherwise.

public boolean isReadOnly(String key)

Tests the mutability of a property.

Parameters

key:String: The property name.

Returns:boolean

true if the property is read-only; false, otherwise.

put back to summary

put	back to summary
public Object put(String key, Object value) Overrides java.util.AbstractMap.put. Implements java.util.Map.put. Invokes a setter method for the given property. The `coerce(Object, Class)` method is used as needed to attempt to convert a given value to the property type, as defined by the return value of the getter method. Parameters key:String The property name. value:Object The new property value. Returns:Object Returns `null`, since returning the previous value would require an unnecessary call to the getter method. Annotations @Override Exceptions PropertyNotFoundException: If the given property does not exist or is read-only.

public Object put(String key, Object value)

Overrides java.util.AbstractMap.put.

Implements java.util.Map.put.

Invokes a setter method for the given property. The coerce(Object, Class) method is used as needed to attempt to convert a given value to the property type, as defined by the return value of the getter method.

Parameters

key:String: The property name.
value:Object: The new property value.

Returns:Object

Returns null, since returning the previous value would require an unnecessary call to the getter method.

Annotations

@Override

Exceptions

PropertyNotFoundException:: If the given property does not exist or is read-only.

put back to summary

put	back to summary
public static void put(Object target, Class<?> sourceType, String key, Object value) Invokes a static setter method for the given property. If the value is `null` or there is no explicit setter for a given type, the `coerce(Object, Class)` method is used to attempt to convert the value to the actual property type (defined by the return value of the getter method). Parameters target:Object The object to which the property is or will be attached. sourceType:Class<?> The class that defines the property. key:String The property name. value:Object The new property value. Exceptions PropertyNotFoundException: If the given static property does not exist or is read-only.

public static void put(Object target, Class<?> sourceType, String key, Object value)

Invokes a static setter method for the given property. If the value is null or there is no explicit setter for a given type, the coerce(Object, Class) method is used to attempt to convert the value to the actual property type (defined by the return value of the getter method).

Parameters

target:Object: The object to which the property is or will be attached.
sourceType:Class<?>: The class that defines the property.
key:String: The property name.
value:Object: The new property value.

Exceptions

PropertyNotFoundException:: If the given static property does not exist or is read-only.

toAllCaps	back to summary
private static String toAllCaps(String value)

public Class BeanAdapter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BeanAdapter.MethodCache

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final Map<String, List<Method>>	methods
private final BeanAdapter.MethodCache	nextClassCache