groovy.util
Class FactoryBuilderSupport

java.lang.Object
  groovy.lang.GroovyObjectSupport
      groovy.lang.Binding
          groovy.util.FactoryBuilderSupport

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.

author:

James Strachan

author:

Andres Almiray

author:

Danno Ferrin

CHILD_BUILDER

static final String CHILD_BUILDER

CURRENT_BUILDER

static final String CURRENT_BUILDER

CURRENT_FACTORY

static final String CURRENT_FACTORY

CURRENT_NAME

static final String CURRENT_NAME

CURRENT_NODE

static final String CURRENT_NODE

OWNER

static final String OWNER

PARENT_BUILDER

static final String PARENT_BUILDER

PARENT_CONTEXT

static final String PARENT_CONTEXT

PARENT_FACTORY

static final String PARENT_FACTORY

PARENT_NAME

static final String PARENT_NAME

PARENT_NODE

static final String PARENT_NODE

attributeDelegates

protected LinkedList attributeDelegates

autoRegistrationComplete

protected boolean autoRegistrationComplete

autoRegistrationRunning

protected boolean autoRegistrationRunning

explicitMethods

protected Map explicitMethods

explicitProperties

protected Map explicitProperties

postInstantiateDelegates

protected LinkedList postInstantiateDelegates

postNodeCompletionDelegates

protected LinkedList postNodeCompletionDelegates

preInstantiateDelegates

protected LinkedList preInstantiateDelegates

registrationGroup

protected Map registrationGroup

registrationGroupName

protected String registrationGroupName

FactoryBuilderSupport

public FactoryBuilderSupport()

FactoryBuilderSupport

public FactoryBuilderSupport(boolean init)

FactoryBuilderSupport

@Deprecated
public FactoryBuilderSupport(Closure nameMappingClosure)

addAttributeDelegate

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.

param:

attrDelegate the closure to be called

return:

attrDelegate

addDisposalClosure

public void addDisposalClosure(Closure closure)

addPostInstantiateDelegate

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.

param:

delegate the closure to invoke

return:

delegate

addPostNodeCompletionDelegate

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.

param:

delegate the closure to invoke

return:

delegate

addPreInstantiateDelegate

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.

param:

delegate the closure to invoke

return:

delegate

autoRegisterNodes

public void autoRegisterNodes()

Ask the nodes to be registered

build

public Object build(Class viewClass)

build

public Object build(Script script)

build

public Object build(String script, GroovyClassLoader loader)

checkExplicitMethod

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

checkValueIsNull

public static void checkValueIsNull(Object value, Object name)

Throws an exception if value is null.

param:

value the node's value

param:

name the node's name

checkValueIsType

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

Checks type of value against builder type

param:

value the node's value

param:

name the node's name

param:

type a Class that may be assignable to the value's class

return:

true if type is assignable to the value's class, false if value is null.

checkValueIsTypeNotString

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

Checks values against factory's type

param:

value the node's value

param:

name the node's name

param:

type a Class that may be assignable to the value's class

return:

Returns true if type is assignable to the value's class, false if value is null or a String.

createNode

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

This method is responsible for instanciating a node and configure its properties.

param:

name the name of the node

param:

attributes the attributes for the node

param:

value the value arguments for the node

return:

the object return from the factory

dispathNodeCall

protected Object dispathNodeCall(Object name, Object args)

dispose

public void dispose()

getAttributeDelegates

public List getAttributeDelegates()

getChildBuilder

public FactoryBuilderSupport getChildBuilder()

getContext

public Map getContext()

return:

the context of the current node.

getContextAttribute

public Object getContextAttribute(String key)

getContexts

protected LinkedList getContexts()

return:

the stack of available contexts.

getContinuationData

protected Map getContinuationData()

Stores the thread local states in a Map that can be passed across threads

return:

the map

getCurrent

public Object getCurrent()

return:

the current node being built.

getCurrentBuilder

public FactoryBuilderSupport getCurrentBuilder()

return:

the builder that built the current node.

getCurrentFactory

public Factory getCurrentFactory()

return:

the factory that built the current node.

getCurrentName

public String getCurrentName()

return:

the factory of the parent of the current node.

getExplicitMethods

public Map getExplicitMethods()

return:

the explicit methods map (Unmodifiable Map).

getExplicitProperties

public Map getExplicitProperties()

return:

the explicit properties map (Unmodifiable Map).

getFactories

public Map getFactories()

return:

the factory map (Unmodifiable Map).

getLocalExplicitMethods

public Map getLocalExplicitMethods()

return:

the explicit methods map (Unmodifiable Map).

getLocalExplicitProperties

public Map getLocalExplicitProperties()

return:

the explicit properties map (Unmodifiable Map).

getLocalFactories

public Map getLocalFactories()

return:

the factory map (Unmodifiable Map).

getName

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.

param:

methodName the name of the desired method

return:

the object representing the name

getNameMappingClosure

public Closure getNameMappingClosure()

getParentContext

public Map getParentContext()

return:

the context of the parent of the current node.

getParentFactory

public Factory getParentFactory()

return:

the factory of the parent of the current node.

getParentName

public String getParentName()

return:

the name of the parent of the current node.

getParentNode

public Object getParentNode()

return:

the node of the parent of the current node.

getPostInstantiateDelegates

public List getPostInstantiateDelegates()

getPostNodeCompletionDelegates

public List getPostNodeCompletionDelegates()

getPreInstantiateDelegates

public List getPreInstantiateDelegates()

getProperty

public Object getProperty(String property)

Overloaded to make variables appear as bean properties or via the subscript operator

getProxyBuilder

protected FactoryBuilderSupport getProxyBuilder()

Proxy builders are useful for changing the building context, thus enabling mix & match builders.

return:

the current builder that serves as a proxy.

getRegistrationGroupItems

public Set getRegistrationGroupItems(String group)

getRegistrationGroups

public Set getRegistrationGroups()

getVariable

public Object getVariable(String name)

param:

name the name of the variable to lookup

return:

the variable value

getVariables

public Map getVariables()

handleNodeAttributes

protected void handleNodeAttributes(Object node, Map attributes)

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

param:

node the object returned by tne node factory

param:

attributes the attributes for the node

invokeMethod

public Object invokeMethod(String methodName)

Convenience method when no arguments are required

param:

methodName the name of the method to invoke

return:

the result of the call

invokeMethod

public Object invokeMethod(String methodName, Object args)

newContext

protected void newContext()

Pushes a new context on the stack.

nodeCompleted

protected void nodeCompleted(Object parent, Object node)

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

param:

node the current node being processed

param:

parent the parent of the node being processed

popContext

protected Map popContext()

Removes the last context from the stack.

return:

the contet just removed

postInstantiate

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

A hook after the factory creates the node and before attributes are set.
It will call any registered postInstantiateDelegates, if you override this method be sure to call this impl somewhere in your code.

param:

name the name of the node

param:

attributes the attributes for the node

param:

node the object created by the node factory

postNodeCompletion

protected Object postNodeCompletion(Object parent, Object node)

A hook to allow nodes to be processed once they have had all of their children applied and allows the actual node object that represents the Markup element to be changed.
It will call any registered postNodeCompletionDelegates, if you override this method be sure to call this impl at the end of your code.

param:

node the current node being processed

param:

parent the parent of the node being processed

return:

the node, possibly new, that represents the markup element

preInstantiate

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

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.

param:

name the name of the node

param:

attributes the attributes of the node

param:

value the value argument(s) of the node

registerBeanFactory

public void registerBeanFactory(String theName, Class beanClass)

Registers a factory for a JavaBean.
The JavaBean class should have a no-args constructor.

param:

theName name of the node

param:

beanClass the factory to handle the name

registerBeanFactory

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

Registers a factory for a JavaBean.
The JavaBean class should have a no-args constructor.

param:

theName name of the node

param:

groupName thr group to register this node in

param:

beanClass the factory to handle the name

registerExplicitMethod

public void registerExplicitMethod(String name, Closure closure)

registerExplicitMethod

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

registerExplicitProperty

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

registerExplicitProperty

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

registerFactory

public void registerFactory(String name, Factory factory)

Registers a factory for a node name.

param:

name the name of the node

param:

factory the factory to return the values

registerFactory

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

Registers a factory for a node name.

param:

name the name of the node

param:

groupName thr group to register this node in

param:

factory the factory to return the values

removeAttributeDelegate

public void removeAttributeDelegate(Closure attrDelegate)

Remove the most recently added instance of the attribute delegate.

param:

attrDelegate the instance of the closure to be removed

removePostInstantiateDelegate

public void removePostInstantiateDelegate(Closure delegate)

Remove the most recently added instance of the postInstantiate delegate.

param:

delegate the closure to invoke

removePostNodeCompletionDelegate

public void removePostNodeCompletionDelegate(Closure delegate)

Remove the most recently added instance of the nodeCompletion delegate.

param:

delegate the closure to be removed

removePreInstantiateDelegate

public void removePreInstantiateDelegate(Closure delegate)

Remove the most recently added instance of the preInstantiate delegate.

param:

delegate the closure to invoke

reset

protected void reset()

Clears the context stack.

resolveExplicitMethod

@SuppressWarnings({"UnusedDeclaration"})
protected Closure resolveExplicitMethod(String methodName, Object args)

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

param:

methodName the name of the explicit method

param:

args the arguments for the method

return:

the closure for the matched explicit method.

resolveExplicitProperty

protected Closure[] resolveExplicitProperty(String propertyName)

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

param:

propertyName the name of the explicit method

return:

the get and set closures (in that order) for the matched explicit property.

resolveFactory

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.

param:

name the name of the factory

param:

attributes the attributes from the node

param:

value value arguments from te node

return:

the Factory associated with name.

restoreFromContinuationData

protected void restoreFromContinuationData(Map data)

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,

param:

data the data retrieved from a compatible getContinuationData call

setClosureDelegate

@SuppressWarnings({"UnusedDeclaration"})
protected void setClosureDelegate(Closure closure, Object node)

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)

param:

closure the closure on which to call setDelegate()

param:

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

setNameMappingClosure

public void setNameMappingClosure(Closure nameMappingClosure)

setNodeAttributes

protected void setNodeAttributes(Object node, Map attributes)

Maps attributes key/values to properties on node.

param:

node the object from the node

param:

attributes the attributes to be set

setParent

protected void setParent(Object parent, Object child)

Strategy method to establish parent/child relationships.

param:

parent the object from the parent node

param:

child the object from the child node

setProperty

public void setProperty(String property, Object newValue)

Overloaded to make variables appear as bean properties or via the subscript operator

setProxyBuilder

protected void setProxyBuilder(FactoryBuilderSupport proxyBuilder)

Sets the builder to be used as a proxy.

param:

proxyBuilder the new proxy

setVariable

public void setVariable(String name, Object value)

Sets the value of the given variable

param:

name the name of the variable to set

param:

value the new value for the given variable

withBuilder

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.

param:

builder the temporary builder to switch to as proxyBuilder.

param:

closure the closure to be executed under the temporary builder.

return:

the execution result of the closure.

throws:

RuntimeException - any exception the closure might have thrown during execution.

withBuilder

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

param:

builder the temporary builder to switch to as proxyBuilder.

param:

name the node to build on the 'parent' builder.

param:

closure the closure to be executed under the temporary builder.

return:

a node that responds to value of name with the closure's result as its value.

throws:

RuntimeException - any exception the closure might have thrown during execution.

withBuilder

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.

param:

attributes additional properties for the node on the parent builder.

param:

builder the temporary builder to switch to as proxyBuilder.

param:

name the node to build on the 'parent' builder.

param:

closure the closure to be executed under the temporary builder.

return:

a node that responds to value of name with the closure's result as its value.

throws:

RuntimeException - any exception the closure might have thrown during execution.

Copyright © 2003-2009 The Codehaus. All rights reserved.