FactoryBuilderSupport (Groovy 4.0.5)

groovy.util.FactoryBuilderSupport

```
public abstract class FactoryBuilderSupport
extends Binding
```
Mix of BuilderSupport and SwingBuilder's factory support. Warning: this implementation is not thread safe and should not be used across threads in a multi-threaded environment. A locking mechanism should be implemented by the subclass if use is expected across multiple threads.

Field Summary

Fields
Modifiers	Name	Description
`static String`	`CHILD_BUILDER`
`static String`	`CURRENT_BUILDER`
`static String`	`CURRENT_FACTORY`
`static String`	`CURRENT_NAME`
`static String`	`CURRENT_NODE`
`static String`	`OWNER`
`static String`	`PARENT_BUILDER`
`static String`	`PARENT_CONTEXT`
`static String`	`PARENT_FACTORY`
`static String`	`PARENT_NAME`
`static String`	`PARENT_NODE`
`static String`	`SCRIPT_CLASS_NAME`

Constructor Summary

Constructors
Constructor and description
`FactoryBuilderSupport()`
`FactoryBuilderSupport(boolean init)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public Closure`	`addAttributeDelegate(Closure attrDelegate)` Add an attribute delegate so it can intercept attributes being set.
	`public void`	`addDisposalClosure(Closure closure)`
	`public Closure`	`addPostInstantiateDelegate(Closure delegate)` Add a postInstantiate delegate so it can intercept nodes after they are created.
	`public Closure`	`addPostNodeCompletionDelegate(Closure delegate)` Add a nodeCompletion delegate so it can intercept nodes after they done with building.
	`public Closure`	`addPreInstantiateDelegate(Closure delegate)` Add a preInstantiate delegate so it can intercept nodes before they are created.
	`public void`	`autoRegisterNodes()` Ask the nodes to be registered
	`public Object`	`build(Class viewClass)`
	`public Object`	`build(Script script)`
	`public Object`	`build(String script, GroovyClassLoader loader)`
	`public static void`	`checkValueIsNull(Object value, Object name)` Throws an exception if value is null.
	`public static boolean`	`checkValueIsType(Object value, Object name, Class type)` Checks type of value against builder type
	`public static boolean`	`checkValueIsTypeNotString(Object value, Object name, Class type)` Checks values against factory's type
	`public void`	`dispose()`
	`public List<Closure>`	`getAttributeDelegates()`
	`public FactoryBuilderSupport`	`getChildBuilder()`
	`public Map<String, Object>`	`getContext()` Returns: the context of the current node.
	`public Object`	`getContextAttribute(String key)`
	`public Object`	`getCurrent()` Returns: the current node being built.
	`public FactoryBuilderSupport`	`getCurrentBuilder()` Returns: the builder that built the current node.
	`public Factory`	`getCurrentFactory()` Returns: the factory that built the current node.
	`public String`	`getCurrentName()` Returns: the factory of the parent of the current node.
	`public List<Closure>`	`getDisposalClosures()`
	`public Map<String, Closure>`	`getExplicitMethods()` Returns: the explicit methods map (Unmodifiable Map).
	`public Map<String, Closure>`	`getExplicitProperties()` Returns: the explicit properties map (Unmodifiable Map).
	`public Map<String, Factory>`	`getFactories()` Returns: the factory map (Unmodifiable Map).
	`public Map<String, Closure>`	`getLocalExplicitMethods()` Returns: the explicit methods map (Unmodifiable Map).
	`public Map<String, Closure>`	`getLocalExplicitProperties()` Returns: the explicit properties map (Unmodifiable Map).
	`public Map<String, Factory>`	`getLocalFactories()` Returns: the factory map (Unmodifiable Map).
	`public Closure`	`getMethodMissingDelegate()`
	`public Object`	`getName(String methodName)` A hook to allow names to be converted into some other object such as a QName in XML or ObjectName in JMX.
	`public Closure`	`getNameMappingClosure()`
	`public Map`	`getParentContext()` Returns: the context of the parent of the current node.
	`public Factory`	`getParentFactory()` Returns: the factory of the parent of the current node.
	`public String`	`getParentName()` Returns: the name of the parent of the current node.
	`public Object`	`getParentNode()` Returns: the node of the parent of the current node.
	`public List<Closure>`	`getPostInstantiateDelegates()`
	`public List<Closure>`	`getPostNodeCompletionDelegates()`
	`public List<Closure>`	`getPreInstantiateDelegates()`
	`public Object`	`getProperty(String property)` Overloaded to make variables appear as bean properties or via the subscript operator
	`public Closure`	`getPropertyMissingDelegate()`
	`public Set<String>`	`getRegistrationGroupItems(String group)`
	`public Set<String>`	`getRegistrationGroups()`
	`public Object`	`getVariable(String name)` Parameters: `name` - the name of the variable to lookup
	`public Map`	`getVariables()`
	`public Object`	`invokeMethod(String methodName)` Convenience method when no arguments are required
	`public Object`	`invokeMethod(String methodName, Object args)`
	`public Object`	`newInstance(FactoryBuilderSupport builder, Object name, Object value, Map properties)`
	`public void`	`registerBeanFactory(String theName, Class beanClass)` Registers a factory for a JavaBean.
	`public void`	`registerBeanFactory(String theName, String groupName, Class beanClass)` Registers a factory for a JavaBean.
	`public void`	`registerExplicitMethod(String name, Closure closure)`
	`public void`	`registerExplicitMethod(String name, String groupName, Closure closure)`
	`public void`	`registerExplicitProperty(String name, Closure getter, Closure setter)`
	`public void`	`registerExplicitProperty(String name, String groupName, Closure getter, Closure setter)`
	`public void`	`registerFactory(String name, Factory factory)` Registers a factory for a node name.
	`public void`	`registerFactory(String name, String groupName, Factory factory)` Registers a factory for a node name.
	`public void`	`removeAttributeDelegate(Closure attrDelegate)` Remove the most recently added instance of the attribute delegate.
	`public void`	`removePostInstantiateDelegate(Closure delegate)` Remove the most recently added instance of the postInstantiate delegate.
	`public void`	`removePostNodeCompletionDelegate(Closure delegate)` Remove the most recently added instance of the nodeCompletion delegate.
	`public void`	`removePreInstantiateDelegate(Closure delegate)` Remove the most recently added instance of the preInstantiate delegate.
	`public void`	`setMethodMissingDelegate(Closure delegate)`
	`public void`	`setNameMappingClosure(Closure nameMappingClosure)`
	`public void`	`setProperty(String property, Object newValue)` Overloaded to make variables appear as bean properties or via the subscript operator
	`public void`	`setPropertyMissingDelegate(Closure delegate)`
	`public void`	`setVariable(String name, Object value)` Sets the value of the given variable
	`public Object`	`withBuilder(FactoryBuilderSupport builder, Closure closure)` Switches the builder's proxyBuilder during the execution of a closure.
	`public Object`	`withBuilder(FactoryBuilderSupport builder, String name, Closure closure)` Switches the builder's proxyBuilder during the execution of a closure.
	`public Object`	`withBuilder(Map attributes, FactoryBuilderSupport builder, String name, Closure closure)` Switches the builder's proxyBuilder during the execution of a closure.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Binding`	`getProperty, getVariable, getVariables, hasVariable, removeVariable, setProperty, setVariable`
`class GroovyObjectSupport`	`getMetaClass, setMetaClass`

- Field Detail
  - public static final String CHILD_BUILDER
  - public static final String CURRENT_BUILDER
  - public static final String CURRENT_FACTORY
  - public static final String CURRENT_NAME
  - public static final String CURRENT_NODE
  - public static final String OWNER
  - public static final String PARENT_BUILDER
  - public static final String PARENT_CONTEXT
  - public static final String PARENT_FACTORY
  - public static final String PARENT_NAME
  - public static final String PARENT_NODE
  - public static final String SCRIPT_CLASS_NAME
- Constructor Detail
  - public FactoryBuilderSupport()
  - public FactoryBuilderSupport(boolean init)
- Method Detail
  - public Closure addAttributeDelegate(Closure attrDelegate)
    
    Add an attribute delegate so it can intercept attributes being set. Attribute delegates are fired in a FILO pattern, so that nested delegates get first crack.
    Parameters:
    attrDelegate - the closure to be called
    Returns:
    attrDelegate
  - public void addDisposalClosure(Closure closure)
  - public Closure addPostInstantiateDelegate(Closure delegate)
    
    Add a postInstantiate delegate so it can intercept nodes after they are created. PostInstantiate delegates are fired in a FILO pattern, so that nested delegates get first crack.
    Parameters:
    delegate - the closure to invoke
    Returns:
    delegate
  - public Closure addPostNodeCompletionDelegate(Closure delegate)
    
    Add a nodeCompletion delegate so it can intercept nodes after they done with building. NodeCompletion delegates are fired in a FILO pattern, so that nested delegates get first crack.
    Parameters:
    delegate - the closure to invoke
    Returns:
    delegate
  - public Closure addPreInstantiateDelegate(Closure delegate)
    
    Add a preInstantiate delegate so it can intercept nodes before they are created. PreInstantiate delegates are fired in a FILO pattern, so that nested delegates get first crack.
    Parameters:
    delegate - the closure to invoke
    Returns:
    delegate
  - public void autoRegisterNodes()
    
    Ask the nodes to be registered
  - public Object build(Class viewClass)
  - public Object build(Script script)
  - public Object build(String script, GroovyClassLoader loader)
  - public static void checkValueIsNull(Object value, Object name)
    
    Throws an exception if value is null.
    Parameters:
    value - the node's value
    name - the node's name
  - public static boolean checkValueIsType(Object value, Object name, Class type)
    
    Checks type of value against builder type
    Parameters:
    value - the node's value
    name - the node's name
    type - a Class that may be assignable to the value's class
    Returns:
    true if type is assignable to the value's class, false if value is null.
  - public static boolean checkValueIsTypeNotString(Object value, Object name, Class type)
    
    Checks values against factory's type
    Parameters:
    value - the node's value
    name - the node's name
    type - a Class that may be assignable to the value's class
    Returns:
    Returns true if type is assignable to the value's class, false if value is null or a String.
  - public void dispose()
  - public List<Closure> getAttributeDelegates()
  - public FactoryBuilderSupport getChildBuilder()
  - public Map<String, Object> getContext()
    
    Returns:
    the context of the current node.
  - public Object getContextAttribute(String key)
  - public Object getCurrent()
    
    Returns:
    the current node being built.
  - public FactoryBuilderSupport getCurrentBuilder()
    
    Returns:
    the builder that built the current node.
  - public Factory getCurrentFactory()
    
    Returns:
    the factory that built the current node.
  - public String getCurrentName()
    
    Returns:
    the factory of the parent of the current node.
  - public List<Closure> getDisposalClosures()
  - public Map<String, Closure> getExplicitMethods()
    
    Returns:
    the explicit methods map (Unmodifiable Map).
  - public Map<String, Closure> getExplicitProperties()
    
    Returns:
    the explicit properties map (Unmodifiable Map).
  - public Map<String, Factory> getFactories()
    
    Returns:
    the factory map (Unmodifiable Map).
  - public Map<String, Closure> getLocalExplicitMethods()
    
    Returns:
    the explicit methods map (Unmodifiable Map).
  - public Map<String, Closure> getLocalExplicitProperties()
    
    Returns:
    the explicit properties map (Unmodifiable Map).
  - public Map<String, Factory> getLocalFactories()
    
    Returns:
    the factory map (Unmodifiable Map).
  - public Closure getMethodMissingDelegate()
  - public Object getName(String methodName)
    
    A hook to allow names to be converted into some other object such as a QName in XML or ObjectName in JMX.
    Parameters:
    methodName - the name of the desired method
    Returns:
    the object representing the name
  - public Closure getNameMappingClosure()
  - public Map getParentContext()
    
    Returns:
    the context of the parent of the current node.
  - public Factory getParentFactory()
    
    Returns:
    the factory of the parent of the current node.
  - public String getParentName()
    
    Returns:
    the name of the parent of the current node.
  - public Object getParentNode()
    
    Returns:
    the node of the parent of the current node.
  - public List<Closure> getPostInstantiateDelegates()
  - public List<Closure> getPostNodeCompletionDelegates()
  - public List<Closure> getPreInstantiateDelegates()
  - @Override
    public Object getProperty(String property)
    
    Overloaded to make variables appear as bean properties or via the subscript operator
  - public Closure getPropertyMissingDelegate()
  - public Set<String> getRegistrationGroupItems(String group)
  - public Set<String> getRegistrationGroups()
  - @Override
    public Object getVariable(String name)
    
    Parameters:
    name - the name of the variable to lookup
    Returns:
    the variable value
  - @Override
    public Map getVariables()
  - public Object invokeMethod(String methodName)
    
    Convenience method when no arguments are required
    Parameters:
    methodName - the name of the method to invoke
    Returns:
    the result of the call
  - @Override
    public Object invokeMethod(String methodName, Object args)
  - @Override
    public Object newInstance(FactoryBuilderSupport builder, Object name, Object value, Map properties)
  - public void registerBeanFactory(String theName, Class beanClass)
    
    Registers a factory for a JavaBean.
    The JavaBean class should have a no-args constructor.
    Parameters:
    theName - name of the node
    beanClass - the factory to handle the name
  - public void registerBeanFactory(String theName, String groupName, Class beanClass)
    
    Registers a factory for a JavaBean.
    The JavaBean class should have a no-args constructor.
    Parameters:
    theName - name of the node
    groupName - thr group to register this node in
    beanClass - the factory to handle the name
  - public void registerExplicitMethod(String name, Closure closure)
  - public void registerExplicitMethod(String name, String groupName, Closure closure)
  - public void registerExplicitProperty(String name, Closure getter, Closure setter)
  - public void registerExplicitProperty(String name, String groupName, Closure getter, Closure setter)
  - public void registerFactory(String name, Factory factory)
    
    Registers a factory for a node name.
    Parameters:
    name - the name of the node
    factory - the factory to return the values
  - public void registerFactory(String name, String groupName, Factory factory)
    
    Registers a factory for a node name.
    Parameters:
    name - the name of the node
    groupName - thr group to register this node in
    factory - the factory to return the values
  - public void removeAttributeDelegate(Closure attrDelegate)
    
    Remove the most recently added instance of the attribute delegate.
    Parameters:
    attrDelegate - the instance of the closure to be removed
  - public void removePostInstantiateDelegate(Closure delegate)
    
    Remove the most recently added instance of the postInstantiate delegate.
    Parameters:
    delegate - the closure to invoke
  - public void removePostNodeCompletionDelegate(Closure delegate)
    
    Remove the most recently added instance of the nodeCompletion delegate.
    Parameters:
    delegate - the closure to be removed
  - public void removePreInstantiateDelegate(Closure delegate)
    
    Remove the most recently added instance of the preInstantiate delegate.
    Parameters:
    delegate - the closure to invoke
  - public void setMethodMissingDelegate(Closure delegate)
  - public void setNameMappingClosure(Closure nameMappingClosure)
  - @Override
    public void setProperty(String property, Object newValue)
    
    Overloaded to make variables appear as bean properties or via the subscript operator
  - public void setPropertyMissingDelegate(Closure delegate)
  - @Override
    public void setVariable(String name, Object value)
    
    Sets the value of the given variable
    Parameters:
    name - the name of the variable to set
    value - the new value for the given variable
  - public Object withBuilder(FactoryBuilderSupport builder, Closure closure)
    
    Switches the builder's proxyBuilder during the execution of a closure.
    This is useful to temporary change the building context to another builder without the need for a contrived setup. It will also take care of restoring the previous proxyBuilder when the execution finishes, even if an exception was thrown from inside the closure.
    throws:
    RuntimeException - any exception the closure might have thrown during execution.
    
    Parameters:
    builder - the temporary builder to switch to as proxyBuilder.
    closure - the closure to be executed under the temporary builder.
    Returns:
    the execution result of the closure.
  - public Object withBuilder(FactoryBuilderSupport builder, String name, Closure closure)
    
    Switches the builder's proxyBuilder during the execution of a closure.
    This is useful to temporary change the building context to another builder without the need for a contrived setup. It will also take care of restoring the previous proxyBuilder when the execution finishes, even if an exception was thrown from inside the closure. Additionally it will use the closure's result as the value for the node identified by 'name'.
    throws:
    RuntimeException - any exception the closure might have thrown during execution.
    
    Parameters:
    builder - the temporary builder to switch to as proxyBuilder.
    name - the node to build on the 'parent' builder.
    closure - the closure to be executed under the temporary builder.
    Returns:
    a node that responds to value of name with the closure's result as its value.
  - public Object withBuilder(Map attributes, FactoryBuilderSupport builder, String name, Closure closure)
    
    Switches the builder's proxyBuilder during the execution of a closure.
    This is useful to temporary change the building context to another builder without the need for a contrived setup. It will also take care of restoring the previous proxyBuilder when the execution finishes, even if an exception was thrown from inside the closure. Additionally it will use the closure's result as the value for the node identified by 'name' and assign any attributes that might have been set.
    throws:
    RuntimeException - any exception the closure might have thrown during execution.
    
    Parameters:
    attributes - additional properties for the node on the parent builder.
    builder - the temporary builder to switch to as proxyBuilder.
    name - the node to build on the 'parent' builder.
    closure - the closure to be executed under the temporary builder.
    Returns:
    a node that responds to value of name with the closure's result as its value.

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class FactoryBuilderSupport

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String CHILD_BUILDER

public static final String CURRENT_BUILDER

public static final String CURRENT_FACTORY

public static final String CURRENT_NAME

public static final String CURRENT_NODE

public static final String OWNER

public static final String PARENT_BUILDER

public static final String PARENT_CONTEXT

public static final String PARENT_FACTORY

public static final String PARENT_NAME

public static final String PARENT_NODE

public static final String SCRIPT_CLASS_NAME

Constructor Detail

public FactoryBuilderSupport()

public FactoryBuilderSupport(boolean init)

Method Detail

public Closure addAttributeDelegate(Closure attrDelegate)

public void addDisposalClosure(Closure closure)

public Closure addPostInstantiateDelegate(Closure delegate)

public Closure addPostNodeCompletionDelegate(Closure delegate)

public Closure addPreInstantiateDelegate(Closure delegate)

public void autoRegisterNodes()

public Object build(Class viewClass)

public Object build(Script script)

public Object build(String script, GroovyClassLoader loader)

public static void checkValueIsNull(Object value, Object name)

public static boolean checkValueIsType(Object value, Object name, Class type)

public static boolean checkValueIsTypeNotString(Object value, Object name, Class type)

public void dispose()

public List<Closure> getAttributeDelegates()

public FactoryBuilderSupport getChildBuilder()

public Map<String, Object> getContext()

public Object getContextAttribute(String key)

public Object getCurrent()

public FactoryBuilderSupport getCurrentBuilder()

public Factory getCurrentFactory()

public String getCurrentName()

public List<Closure> getDisposalClosures()

public Map<String, Closure> getExplicitMethods()

public Map<String, Closure> getExplicitProperties()

public Map<String, Factory> getFactories()

public Map<String, Closure> getLocalExplicitMethods()

public Map<String, Closure> getLocalExplicitProperties()

public Map<String, Factory> getLocalFactories()

public Closure getMethodMissingDelegate()

public Object getName(String methodName)

public Closure getNameMappingClosure()

public Map getParentContext()

public Factory getParentFactory()

public String getParentName()

public Object getParentNode()

public List<Closure> getPostInstantiateDelegates()

public List<Closure> getPostNodeCompletionDelegates()

public List<Closure> getPreInstantiateDelegates()

@Overridepublic Object getProperty(String property)

public Closure getPropertyMissingDelegate()

public Set<String> getRegistrationGroupItems(String group)

public Set<String> getRegistrationGroups()

@Overridepublic Object getVariable(String name)

@Overridepublic Map getVariables()

public Object invokeMethod(String methodName)

@Overridepublic Object invokeMethod(String methodName, Object args)

@Overridepublic Object newInstance(FactoryBuilderSupport builder, Object name, Object value, Map properties)

public void registerBeanFactory(String theName, Class beanClass)

public void registerBeanFactory(String theName, String groupName, Class beanClass)

public void registerExplicitMethod(String name, Closure closure)

public void registerExplicitMethod(String name, String groupName, Closure closure)

public void registerExplicitProperty(String name, Closure getter, Closure setter)

public void registerExplicitProperty(String name, String groupName, Closure getter, Closure setter)

public void registerFactory(String name, Factory factory)

public void registerFactory(String name, String groupName, Factory factory)

public void removeAttributeDelegate(Closure attrDelegate)

public void removePostInstantiateDelegate(Closure delegate)

public void removePostNodeCompletionDelegate(Closure delegate)

@Override
public Object getProperty(String property)

@Override
public Object getVariable(String name)

@Override
public Map getVariables()

@Override
public Object invokeMethod(String methodName, Object args)

@Override
public Object newInstance(FactoryBuilderSupport builder, Object name, Object value, Map properties)

@Override
public void setProperty(String property, Object newValue)

@Override
public void setVariable(String name, Object value)