groovy.xml
[Groovy] Class StreamingMarkupBuilder

java.lang.Object
  groovy.xml.streamingmarkupsupport.AbstractStreamingBuilder
      groovy.xml.StreamingMarkupBuilder

class StreamingMarkupBuilder
extends AbstractStreamingBuilder

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' )
     }
   }
 }

<root>
   <a a1='one'>
     <b>3 &lt; 5</b>
     <c a2='two'>blah</c>
   </a>
 </root>

• 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

builder

def builder

commentClosure

def commentClosure

Invoked by calling mkp.comment

declarationClosure

def declarationClosure

Invoked by calling mkp.xmlDeclaration

encoding

def encoding

expandEmptyElements

boolean expandEmptyElements

noopClosure

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

pendingStack

def pendingStack

piClosure

def piClosure

Invoked by calling mkp.pi

tagClosure

def tagClosure

unescapedClosure

def unescapedClosure

Invoked by calling mkp.yieldUnescaped. Used to render literal text or markup to the output stream. No escaping is done on the output.

useDoubleQuotes

boolean useDoubleQuotes

StreamingMarkupBuilder

StreamingMarkupBuilder()

bind

def bind(def 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

bindNode

def bindNode(def 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.

Returns:

a Writable to render the markup

See Also:

bind(Closure)

getQt

def getQt()

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