BuilderSupport (Groovy 5.0.0)
Description: declaration: package: groovy.util, class: BuilderSupport

Package groovy.util

# Class BuilderSupport

java.lang.Object
groovy.lang.GroovyObjectSupport
groovy.util.BuilderSupport

All Implemented Interfaces:
  `GroovyObject`

Direct Known Subclasses:
  `AntBuilder`, `DOMBuilder`, `MarkupBuilder`, `NamespaceBuilderSupport`, `NodeBuilder`, `SAXBuilder`

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

  Modifier and Type
  Method
  Description
  `protected abstract Object`
  `createNode(Object name)`
  `protected abstract Object`
  `createNode(Object name, Object value)`
  `protected abstract Object`
  `createNode(Object name, Map attributes)`
  `protected abstract Object`
  `createNode(Object name, Map attributes, Object value)`
  `protected Object`
  `doInvokeMethod(String methodName, Object name, Object args)`
  `protected Object`
  `getCurrent()`
  `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.
  `Object`
  `invokeMethod(String methodName)`
  Convenience method when no arguments are required.
  `Object`
  `invokeMethod(String methodName, Object args)`
  Invokes the given method.
  `protected void`
  `nodeCompleted(Object parent, Object node)`
  A hook to allow nodes to be processed once they have had all of their children applied.
  `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.
  `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.
  `protected void`
  `setCurrent(Object current)`
  `protected abstract void`
  `setParent(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 Details

  - ### BuilderSupport

    public BuilderSupport()

  - ### BuilderSupport

    public BuilderSupport(BuilderSupport proxyBuilder)

  - ### BuilderSupport

    public BuilderSupport(@ClosureParams(value=SimpleType.class,options="java.lang.String") Closure nameMappingClosure, BuilderSupport proxyBuilder)

- ## Method Details

  - ### 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: `GroovyObject`
    Invokes the given method.
    Parameters:
      `methodName` - the name of the method to call
      `args` - the arguments to use for the method call
    Returns:
      the result of invoking the method

  - ### doInvokeMethod

    protected Object doInvokeMethod(String methodName, Object name, Object args)

  - ### 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

  - ### setParent

    protected abstract void setParent(Object parent, Object child)

  - ### createNode

    protected abstract Object createNode(Object name)

  - ### createNode

    protected abstract Object createNode(Object name, Object value)

  - ### createNode

    protected abstract Object createNode(Object name, Map attributes)

  - ### createNode

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

  - ### 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 processed
      `parent` - 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 processed
      `parent` - the parent of the node being processed
    Returns:
      the node, possibly new, that represents the markup element