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

groovy.xml
[Java] Class MarkupBuilderHelper

java.lang.Object
  groovy.xml.MarkupBuilderHelper

public class MarkupBuilderHelper
extends Object

A helper class for MarkupBuilder.

Authors:
Paul King

Constructor Summary
MarkupBuilderHelper(MarkupBuilder builder)

@param builder the builder to delegate to
 
Method Summary
void comment(String value)

Produce a comment in the output.
void pi(Map args)

Produce an XML processing instruction in the output.

void xmlDeclaration(Map args)

Produce an XML declaration in the output.

void yield(Object value)

Prints data in the body of the current tag, escaping XML entities.

void yield(String value)

Prints data in the body of the current tag, escaping XML entities.

void yieldUnescaped(Object value)

Print data in the body of the current tag.

void yieldUnescaped(String value)

Print data in the body of the current tag.

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

Constructor Detail

MarkupBuilderHelper

public MarkupBuilderHelper(MarkupBuilder builder)
Parameters:
builder - the builder to delegate to

 
Method Detail

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>
Parameters:
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"])
Parameters:
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')
Parameters:
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')
Parameters:
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')
Parameters:
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>!').
Parameters:
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>!').
Parameters:
value - the text or markup to print.

 

Copyright &copy; 2003-2013 The Codehaus. All rights reserved.