groovy.xml
Class MarkupBuilderHelper

java.lang.Object
  groovy.xml.MarkupBuilderHelper

class MarkupBuilderHelper
extends Object

A helper class for MarkupBuilder.

author:

Paul King

MarkupBuilderHelper

public MarkupBuilderHelper(MarkupBuilder builder)

param:

builder the builder to delegate to

comment

public void comment(String value)

Produce a comment in the output.

mkp.comment 'string' is equivalent to mkp.yieldUnescaped '<!-- string -->'. To create an element with the name 'comment', you need to supply empty attributes, e.g.:

 comment('hello1')
 

or

 mkp.comment('hello1')
 

will produce:

 <!-- hello1 -->
 

while:

 comment('hello2', [:])
 

will produce:

 <comment>hello2</comment>
 

param:

value the text within the comment.

pi

public void pi(Map args)

Produce an XML processing instruction in the output. For example:

 mkp.pi("xml-stylesheet":[href:"mystyle.css", type:"text/css"])
 

param:

args a map with a single entry whose key is the name of the processing instruction and whose value is the attributes for the processing instruction.

xmlDeclaration

public void xmlDeclaration(Map args)

Produce an XML declaration in the output. For example:

 mkp.xmlDeclaration(version:'1.0')
 

param:

args the attributes for the declaration

yield

public void yield(Object value)

Prints data in the body of the current tag, escaping XML entities. For example: mkp.yield('5 < 7')

param:

value an Object whose toString() representation is to be printed

yield

public void yield(String value)

Prints data in the body of the current tag, escaping XML entities. For example: mkp.yield('5 < 7')

param:

value text to print

yieldUnescaped

public void yieldUnescaped(Object value)

Print data in the body of the current tag. Does not escape XML entities. For example: mkp.yieldUnescaped('I am <i>happy</i>!').

param:

value an Object whose toString() representation is to be printed

yieldUnescaped

public void yieldUnescaped(String value)

Print data in the body of the current tag. Does not escape XML entities. For example: mkp.yieldUnescaped('I am <i>happy</i>!').

param:

value the text or markup to print.

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