APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javafx.fxml

public final Class JavaFXBuilderFactory

extends Object
implements BuilderFactory
Class Inheritance
All Implemented Interfaces
javafx.util.BuilderFactory
Imports
com.sun.javafx.fxml.BeanAdapter, com.sun.javafx.fxml.builder.JavaFXFontBuilder, .JavaFXImageBuilder, .JavaFXSceneBuilder, .ProxyBuilder, .TriangleMeshBuilder, .URLBuilder, com.sun.javafx.logging.PlatformLogger, java.lang.annotation.Annotation, java.lang.reflect.Array, .Constructor, .InvocationTargetException, .Method, .Modifier, java.net.URL, java.util.AbstractMap, .ArrayList, .Arrays, .Collection, .HashMap, .HashSet, .Iterator, .List, .Map, .Set, javafx.application.ConditionalFeature, .Platform, javafx.beans.NamedArg, javafx.collections.FXCollections, .ObservableList, .ObservableMap, javafx.scene.Node, .Scene, javafx.scene.image.Image, javafx.scene.shape.TriangleMesh, javafx.scene.text.Font, javafx.util.Builder, .BuilderFactory, com.sun.javafx.reflect.ConstructorUtil, .MethodUtil
JavaFX builder factory.
Since
JavaFX 2.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
JavaFXBuilderFactory.ObjectBuilderWrapper

Legacy ObjectBuilder wrapper.

Field Summary

Modifier and TypeField and Description
private final ClassLoader
classLoader

private final boolean
webSupported

private static final String
WEBVIEW_BUILDER_NAME

private static final String
WEBVIEW_NAME

Constructor Summary

AccessConstructor and Description
public
JavaFXBuilderFactory()

Default constructor.

public
JavaFXBuilderFactory(ClassLoader
the class loader to use when loading classes
classLoader)

Constructor that takes a class loader.

Method Summary

Modifier and TypeMethod and Description
public Builder<?>

Returns:

the builder for the class, or null if no builder is used
getBuilder(Class<?>
the class being looked up
type)

Implements javafx.util.BuilderFactory.getBuilder.

Returns the builder for the specified type, or null if no builder is used.

private boolean
scanForConstructorAnnotations(Class<?> type)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

classLoaderback to summary
private final ClassLoader classLoader
webSupportedback to summary
private final boolean webSupported
WEBVIEW_BUILDER_NAMEback to summary
private static final String WEBVIEW_BUILDER_NAME
WEBVIEW_NAMEback to summary
private static final String WEBVIEW_NAME

Constructor Detail

JavaFXBuilderFactoryback to summary
public JavaFXBuilderFactory()

Default constructor.

JavaFXBuilderFactoryback to summary
public JavaFXBuilderFactory(ClassLoader classLoader)

Constructor that takes a class loader.

Parameters
classLoader:ClassLoader

the class loader to use when loading classes

Since
JavaFX 2.1

Method Detail

getBuilderback to summary
public Builder<?> getBuilder(Class<?> type)

Implements javafx.util.BuilderFactory.getBuilder.

Returns the builder for the specified type, or null if no builder is used. Most classes will not use a builder.

Parameters
type:Class<?>

the class being looked up

Returns:Builder<?>

the builder for the class, or null if no builder is used

Annotations
@Override
scanForConstructorAnnotationsback to summary
private boolean scanForConstructorAnnotations(Class<?> type)
javafx.fxml back to summary

private final Class JavaFXBuilderFactory.ObjectBuilderWrapper

extends Object
Class Inheritance
Legacy ObjectBuilder wrapper.

Todo

move this legacy functionality to JavaFXWebViewBuilder and modify it to work without requiring the legacy builders. See JDK-8089907.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv class
JavaFXBuilderFactory.ObjectBuilderWrapper.ObjectBuilder

Field Summary

Modifier and TypeField and Description
private final Class<?>
builderClass

private final Method
buildMethod

private final Method
createMethod

private final Map<String, Method>
getters

private final Map<String, Method>
methods

private static final Object[]
NO_ARGS

private static final Class<?>[]
NO_SIG

private final Map<String, Method>
setters

Constructor Summary

AccessConstructor and Description
pack-priv
ObjectBuilderWrapper()

pack-priv
ObjectBuilderWrapper(Class<?> builderClass)

Method Summary

Modifier and TypeMethod and Description
pack-priv Builder<Object>
createBuilder()

private Method
findMethod(String name)

public Class<?>

Returns:

The type constructed by this builder.
getTargetClass()

The type constructed by this builder.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

builderClassback to summary
private final Class<?> builderClass
buildMethodback to summary
private final Method buildMethod
createMethodback to summary
private final Method createMethod
gettersback to summary
private final Map<String, Method> getters
methodsback to summary
private final Map<String, Method> methods
NO_ARGSback to summary
private static final Object[] NO_ARGS
NO_SIGback to summary
private static final Class<?>[] NO_SIG
settersback to summary
private final Map<String, Method> setters

Constructor Detail

ObjectBuilderWrapperback to summary
pack-priv ObjectBuilderWrapper()
ObjectBuilderWrapperback to summary
pack-priv ObjectBuilderWrapper(Class<?> builderClass) throws NoSuchMethodException

Method Detail

createBuilderback to summary
pack-priv Builder<Object> createBuilder()
findMethodback to summary
private Method findMethod(String name)
getTargetClassback to summary
public Class<?> getTargetClass()

The type constructed by this builder.

Returns:Class<?>

The type constructed by this builder.

javafx.fxml back to summary

pack-priv final Class JavaFXBuilderFactory.ObjectBuilderWrapper.ObjectBuilder

extends AbstractMap<String, Object>
implements Builder<Object>
Class Inheritance
All Implemented Interfaces
javafx.util.Builder

Field Summary

Modifier and TypeField and Description
private Object
builder

private final Map<String, Object>
containers

private Map<Object, Object>
properties

Constructor Summary

AccessConstructor and Description
private
ObjectBuilder()

Method Summary

Modifier and TypeMethod and Description
public Object
build()

Implements javafx.util.Builder.build.

Builds and returns the object.

public void
clear()

Overrides java.util.AbstractMap.clear.

Implements java.util.Map.clear.

Removes all of the mappings from this map (optional operation).

public boolean
containsKey(Object key)

Overrides java.util.AbstractMap.containsKey.

Implements java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key.

public boolean
containsValue(Object value)

Overrides java.util.AbstractMap.containsValue.

Implements java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value.

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 Object
get(Object key)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

pack-priv Object
getReadOnlyProperty(String propName)

public Object
getTemporaryContainer(String propName)

This is used to support read-only collection property.

public boolean
isEmpty()

Overrides java.util.AbstractMap.isEmpty.

Implements java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

public Set<String>
keySet()

Overrides java.util.AbstractMap.keySet.

Implements java.util.Map.keySet.

Returns a Set view of the keys contained in this map.

public Object
put(String key, Object value)

Overrides java.util.AbstractMap.put.

Implements java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation).

public void
putAll(Map<? extends String, ? extends Object> m)

Overrides java.util.AbstractMap.putAll.

Implements java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation).

public Object
remove(Object key)

Overrides java.util.AbstractMap.remove.

Implements java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation).

public int
size()

Overrides java.util.AbstractMap.size.

Implements java.util.Map.size.

Returns the number of key-value mappings in this map.

public Collection<Object>
values()

Overrides java.util.AbstractMap.values.

Implements java.util.Map.values.

Returns a Collection view of the values contained in this map.

Inherited from java.util.AbstractMap:
cloneequalshashCodetoString

Field Detail

builderback to summary
private Object builder
containersback to summary
private final Map<String, Object> containers
propertiesback to summary
private Map<Object, Object> properties

Constructor Detail

ObjectBuilderback to summary
private ObjectBuilder()

Method Detail

buildback to summary
public Object build()

Implements javafx.util.Builder.build.

Doc from javafx.util.Builder.build.

Builds and returns the object.

Annotations
@Override
clearback to summary
public void clear()

Overrides java.util.AbstractMap.clear.

Implements java.util.Map.clear.

Doc from java.util.AbstractMap.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Annotations
@Override
containsKeyback to summary
public boolean containsKey(Object key)

Overrides java.util.AbstractMap.containsKey.

Implements java.util.Map.containsKey.

Doc from java.util.AbstractMap.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Annotations
@Override
containsValueback to summary
public boolean containsValue(Object value)

Overrides java.util.AbstractMap.containsValue.

Implements java.util.Map.containsValue.

Doc from java.util.AbstractMap.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Annotations
@Override
entrySetback 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.

Annotations
@Override
getback to summary
public Object get(Object key)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

Doc from java.util.AbstractMap.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Annotations
@Override
getReadOnlyPropertyback to summary
pack-priv Object getReadOnlyProperty(String propName)
getTemporaryContainerback to summary
public Object getTemporaryContainer(String propName)

This is used to support read-only collection property. This method must return a Collection of the appropriate type if 1. the property is read-only, and 2. the property is a collection. It must return null otherwise.

isEmptyback to summary
public boolean isEmpty()

Overrides java.util.AbstractMap.isEmpty.

Implements java.util.Map.isEmpty.

Doc from java.util.AbstractMap.isEmpty.

Returns true if this map contains no key-value mappings.

Annotations
@Override
keySetback to summary
public Set<String> keySet()

Overrides java.util.AbstractMap.keySet.

Implements java.util.Map.keySet.

Doc from java.util.AbstractMap.keySet.

Returns a Set view of the keys 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), 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.

Annotations
@Override
putback to summary
public Object put(String key, Object value)

Overrides java.util.AbstractMap.put.

Implements java.util.Map.put.

Doc from java.util.AbstractMap.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Annotations
@Override
@SuppressWarnings:unchecked
putAllback to summary
public void putAll(Map<? extends String, ? extends Object> m)

Overrides java.util.AbstractMap.putAll.

Implements java.util.Map.putAll.

Doc from java.util.AbstractMap.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Annotations
@Override
removeback to summary
public Object remove(Object key)

Overrides java.util.AbstractMap.remove.

Implements java.util.Map.remove.

Doc from java.util.AbstractMap.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Annotations
@Override
sizeback to summary
public int size()

Overrides java.util.AbstractMap.size.

Implements java.util.Map.size.

Doc from java.util.AbstractMap.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Annotations
@Override
valuesback to summary
public Collection<Object> values()

Overrides java.util.AbstractMap.values.

Implements java.util.Map.values.

Doc from java.util.AbstractMap.values.

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

Annotations
@Override