Overview  Package   Class  Deprecated  Index  Help 
Groovy 1.7.2
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

groovy.xml
Class StreamingMarkupBuilder

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

public class StreamingMarkupBuilder
extends AbstractStreamingBuilder

A builder class for creating XML markup. This implementation uses a StreamingMarkupWriter to handle output.

Example:

new StreamingMarkupBuilder().bind {
   root {
     a( a1:'one' ) {
       b { mkp.yield( '3 < 5' ) }
       c( a2:'two', 'blah' )
     }
   }
 }.toString()
Will return the following String, without newlines or indentation: 
<root>
   <a a1='one'>
     <b>3 &lt; 5</b>
     <c a2='two'>blah</c>
   </a>
 </root>
Note 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'.

Constructor Summary
StreamingMarkupBuilder()

 
Method Summary
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.
def bindNode(def node)

Convenience method for binding a single node.

def getQt()

 
Methods inherited from class Object
wait, wait, wait, hashCode, getClass, equals, toString, notify, notifyAll
 

Constructor Detail

StreamingMarkupBuilder

public StreamingMarkupBuilder()

 
Method Detail

bind

public 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() )
return:
a Writable to render the markup

bindNode

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

see:
bind(Closure)
return:
a Writable to render the markup

getQt

public def getQt()

 

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