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

• protected LinkedList attributeDelegates

• protected boolean autoRegistrationComplete

• protected boolean autoRegistrationRunning

• protected Map explicitMethods

• protected Map explicitProperties

• protected Closure methodMissingDelegate

• protected LinkedList postInstantiateDelegates

• protected LinkedList postNodeCompletionDelegates

• protected LinkedList preInstantiateDelegates

• protected Closure propertyMissingDelegate

• protected Map registrationGroup

• protected String registrationGroupName

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)

• public Closure addPostNodeCompletionDelegate(Closure delegate)

• public Closure addPreInstantiateDelegate(Closure 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)

• protected boolean checkExplicitMethod(String methodName, Object args, Reference result)

• 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.

• protected Object createNode(Object name, Map attributes, Object value)

• protected Object dispatchNodeCall(Object name, Object args)

• @Deprecated// should be called on first build method only protected Object dispathNodeCall(Object name, Object args)

  Use FactoryBuilderSupport.dispatchNodeCall instead.

• public void dispose()

• public List getAttributeDelegates()

• public FactoryBuilderSupport getChildBuilder()

• public Map getContext()

• public Object getContextAttribute(String key)

• protected LinkedList getContexts()

  Restores the state of the current builder to the same state as an older build. Caution, this will destroy rather than merge the current build context if there is any,

  Parameters:

  data - the data retrieved from a compatible getContinuationData call

• protected Map getContinuationData()

• public Object getCurrent()

  Returns:

  the current node being built.

• public FactoryBuilderSupport getCurrentBuilder()

  Returns:

  the node of the parent of the current node.

• public Factory getCurrentFactory()

  Returns:

  the factory of the parent of the current node.

• public String getCurrentName()

  Returns:

  the builder that built the current node.

• public List getDisposalClosures()

• public Map getExplicitMethods()

  Returns:

  the explicit properties map (Unmodifiable Map).

• public Map getExplicitProperties()

  Returns:

  the factory map (Unmodifiable Map).

• public Map getFactories()

  Returns:

  the factory map (Unmodifiable Map).

• public Map getLocalExplicitMethods()

  Returns:

  the explicit properties map (Unmodifiable Map).

• public Map getLocalExplicitProperties()

• public Map getLocalFactories()

  Returns:

  the explicit methods 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 name of the parent of the current node.

• public Factory getParentFactory()

  Returns:

  the context of the parent of the current node.

• public String getParentName()

• public Object getParentNode()

  Returns:

  the factory of the parent of the current node.

• public List getPostInstantiateDelegates()

• public List getPostNodeCompletionDelegates()

• public List getPreInstantiateDelegates()

• public Object getProperty(String property)

• public Closure getPropertyMissingDelegate()

• protected FactoryBuilderSupport getProxyBuilder()

• public Set getRegistrationGroupItems(String group)

• public Set getRegistrationGroups()

• public Object getVariable(String name)

  Parameters:

  name - the name of the variable to lookup

  Returns:

  the variable value

• public Map getVariables()

• protected void handleNodeAttributes(Object node, Map attributes)

• 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

• public Object invokeMethod(String methodName, Object args)

• protected void newContext()

  A hook to allow nodes to be processed once they have had all of their children applied.

  Parameters:

  node - the current node being processed

  parent - the parent of the node being processed

• protected void nodeCompleted(Object parent, Object node)

• protected Map popContext()

• protected void postInstantiate(Object name, Map attributes, Object node)

• protected Object postNodeCompletion(Object parent, Object node)

  A hook before the factory creates the node.
  It will call any registered preInstantiateDelegates, if you override this method be sure to call this impl somewhere in your code.

  Parameters:

  name - the name of the node

  attributes - the attributes of the node

  value - the value argument(s) of the node

• protected void preInstantiate(Object name, Map attributes, Object value)

  A strategy method to allow derived builders to use builder-trees and switch in different kinds of builders. This method should call the setDelegate() method on the closure which by default passes in this but if node is-a builder we could pass that in instead (or do something wacky too)

  Parameters:

  closure - the closure on which to call setDelegate()

  node - the node value that we've just created, which could be a builder

• 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)

  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)

• public void removeAttributeDelegate(Closure attrDelegate)

• public void removePostInstantiateDelegate(Closure delegate)

• public void removePostNodeCompletionDelegate(Closure delegate)

• public void removePreInstantiateDelegate(Closure delegate)

• protected void reset()

• @SuppressWarnings*/ protected Closure resolveExplicitMethod(String methodName, Object args)

• protected Closure[] resolveExplicitProperty(String propertyName)

• protected Factory resolveFactory(Object name, Map attributes, Object value)

  This is a hook for subclasses to plugin a custom strategy for mapping names to factories.

  Parameters:

  name - the name of the factory

  attributes - the attributes from the node

  value - value arguments from te node

  Returns:

  the Factory associated with name.
  

• protected void restoreFromContinuationData(Map data)

• @SuppressWarnings* @param parent the object from the parent node protected void setClosureDelegate(Closure closure, Object node)

• public void setMethodMissingDelegate(Closure delegate)

• public void setNameMappingClosure(Closure nameMappingClosure)

• protected void setNodeAttributes(Object node, Map attributes)

• protected void setParent(Object parent, Object child)

  Returns:

  the stack of available contexts.

• 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)

  Returns:

  the context of the current node.

• protected void setProxyBuilder(FactoryBuilderSupport proxyBuilder)

  Assigns any existing properties to the node.
  It will call attributeDelegates before passing control to the factory that built the node.

  Parameters:

  node - the object returned by tne node factory

  attributes - the attributes for the node

• public void setVariable(String name, Object value)

• public Object withBuilder(FactoryBuilderSupport builder, Closure 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)