StreamingMarkupBuilder (groovy 3.0.1 API)

groovy.xml.StreamingMarkupBuilder

A builder class for creating XML markup. This implementation uses a StreamingMarkupWriter to handle output.
Example:
```
System.out << new StreamingMarkupBuilder().bind {
   root {
     a( a1:'one' ) {
       b { mkp.yield( '3 < 5' ) }
       c( a2:'two', 'blah' )
     }
   }
 }
```
Will output the following String, without newlines or indentation:
```
<root>
   <a a1='one'>
     <b>3 &lt; 5</b>
     <c a2='two'>blah</c>
   </a>
 </root>
```
Notes:
- that mkp is a special namespace used to escape away from the normal building mode of the builder and get access to helper markup methods 'yield', 'pi', 'comment', 'out', 'namespaces', 'xmlDeclaration' and 'yieldUnescaped'.
- Note that tab, newline and carriage return characters are escaped within attributes, i.e. will become , and respectively

Properties Summary

Properties
Type	Name and description
`private Object`	`builder`
`private Object`	`commentClosure` Invoked by calling `mkp.comment`
`private Object`	`declarationClosure` Invoked by calling `mkp.xmlDeclaration`
`private Object`	`encoding`
`private boolean`	`expandEmptyElements`
`private Object`	`noopClosure` Invoked by calling `mkp.yield`.
`private Object`	`pendingStack`
`private Object`	`piClosure` Invoked by calling `mkp.pi`
`private Object`	`tagClosure`
`private Object`	`unescapedClosure` Invoked by calling `mkp.yieldUnescaped`.
`private boolean`	`useDoubleQuotes`

Constructor Summary

Constructors
Constructor and description
`StreamingMarkupBuilder ()`
`StreamingMarkupBuilder ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Object`	`bind(Object closure)` Returns a Writable object, which may be used to render the markup directly to a String, or send the output to a stream.
	`Object`	`bindNode(Object node)` Convenience method for binding a single node.
	`Object`	`getQt()`

- Property Detail
  - private Object builder
  - private Object commentClosure
    
    Invoked by calling mkp.comment
  - private Object declarationClosure
    
    Invoked by calling mkp.xmlDeclaration
  - private Object encoding
  - private boolean expandEmptyElements
  - private Object noopClosure
    
    Invoked by calling mkp.yield. Used to render text to the output stream. Any XML reserved characters will be escaped to ensure well-formedness.
  - private Object pendingStack
  - private Object piClosure
    
    Invoked by calling mkp.pi
  - private Object tagClosure
  - private Object unescapedClosure
    
    Invoked by calling mkp.yieldUnescaped. Used to render literal text or markup to the output stream. No escaping is done on the output.
  - private boolean useDoubleQuotes
- Constructor Detail
  - StreamingMarkupBuilder()
  - StreamingMarkupBuilder()
- Method Detail
  - Object bind(Object closure)
    
    Returns a Writable object, which may be used to render the markup directly to a String, or send the output to a stream.
    Examples:
```
 // get the markup as a string:
 new StreamingMarkupBuilder().bind { div { out << "hello world" } }.toString()
 
 // send the output directly to a file:
 new StreamingMarkupBuilder().bind { div { out << "hello world" } } \
      .writeTo( new File('myFile.xml').newWriter() )
 
```
    Returns:
    a Writable to render the markup
  - Object bindNode(Object node)
    
    Convenience method for binding a single node. The call bindNode(node) is equivalent to bind{ out << node }. Returns a Writable object, which may be used to render the markup directly to a String, or send the output to a stream.
    See Also:
    bind(Closure)
    Returns:
    a Writable to render the markup
  - Object getQt()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class StreamingMarkupBuilder

Properties Summary

Constructor Summary

Methods Summary

Property Detail

private Object builder

private Object commentClosure

private Object declarationClosure

private Object encoding

private boolean expandEmptyElements

private Object noopClosure

private Object pendingStack

private Object piClosure

private Object tagClosure

private Object unescapedClosure

private boolean useDoubleQuotes

Constructor Detail

StreamingMarkupBuilder()

StreamingMarkupBuilder()

Method Detail

Object bind(Object closure)

Object bindNode(Object node)

Object getQt()