Package groovy.util
Class BuilderSupport
- java.lang.Object
-
- groovy.lang.GroovyObjectSupport
-
- groovy.util.BuilderSupport
-
- All Implemented Interfaces:
GroovyObject
- Direct Known Subclasses:
NodeBuilder
public abstract class BuilderSupport extends GroovyObjectSupport
Base class for creating arbitrary nested trees of objects or events.
-
-
Constructor Summary
Constructors Constructor Description BuilderSupport()BuilderSupport(Closure nameMappingClosure, BuilderSupport proxyBuilder)BuilderSupport(BuilderSupport proxyBuilder)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract ObjectcreateNode(Object name)protected abstract ObjectcreateNode(Object name, Object value)protected abstract ObjectcreateNode(Object name, Map attributes)protected abstract ObjectcreateNode(Object name, Map attributes, Object value)protected ObjectdoInvokeMethod(String methodName, Object name, Object args)protected ObjectgetCurrent()protected ObjectgetName(String methodName)A hook to allow names to be converted into some other object such as a QName in XML or ObjectName in JMX.ObjectinvokeMethod(String methodName)Convenience method when no arguments are required.ObjectinvokeMethod(String methodName, Object args)Invokes the given method.protected voidnodeCompleted(Object parent, Object node)A hook to allow nodes to be processed once they have had all of their children applied.protected ObjectpostNodeCompletion(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.protected voidsetClosureDelegate(Closure closure, Object node)A strategy method to allow derived builders to use builder-trees and switch in different kinds of builders.protected voidsetCurrent(Object current)protected abstract voidsetParent(Object parent, Object child)-
Methods inherited from class groovy.lang.GroovyObjectSupport
getMetaClass, setMetaClass
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface groovy.lang.GroovyObject
getProperty, setProperty
-
-
-
-
Constructor Detail
-
BuilderSupport
public BuilderSupport()
-
BuilderSupport
public BuilderSupport(BuilderSupport proxyBuilder)
-
BuilderSupport
public BuilderSupport(Closure nameMappingClosure, BuilderSupport proxyBuilder)
-
-
Method Detail
-
getCurrent
protected Object getCurrent()
-
setCurrent
protected void setCurrent(Object current)
-
invokeMethod
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
-
invokeMethod
public Object invokeMethod(String methodName, Object args)
Description copied from interface:GroovyObjectInvokes the given method.- Parameters:
methodName- the name of the method to callargs- the arguments to use for the method call- Returns:
- the result of invoking the method
-
setClosureDelegate
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).- Parameters:
closure- the closure on which to call setDelegate()node- the node value that we've just created, which could be a builder
-
getName
protected 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
-
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.- Parameters:
node- the current node being processedparent- the parent of the node being processed
-
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.- Parameters:
node- the current node being processedparent- the parent of the node being processed- Returns:
- the node, possibly new, that represents the markup element
-
-