groovy.xml

## Class MarkupBuilderHelper

- java.lang.Object
- - groovy.xml.MarkupBuilderHelper

    public class MarkupBuilderHelper
    extends Object

A helper class for MarkupBuilder.

Author:
  Paul King

### Constructor Summary

Constructors
Constructor and Description
`MarkupBuilderHelper(MarkupBuilder builder)`

### Method Summary

Methods
`void` `comment(String value)` Produce a comment in the output.
`void` `pi(Map<String,Map<String,Object>> args)` Produce an XML processing instruction in the output.
`void` `xmlDeclaration(Map<String,Object> 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 java.lang.Object

`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

### Constructor Detail

#### MarkupBuilderHelper

    public MarkupBuilderHelper(MarkupBuilder builder)

Parameters:
  `builder` - the builder to delegate to

### Method Detail

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

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

#### xmlDeclaration

    public void xmlDeclaration(Map<String,Object> args)

Produce an XML declaration in the output. For example:

     mkp.xmlDeclaration(version:'1.0')

Parameters:
  `args` - the attributes for the declaration

#### pi

    public void pi(Map<String,Map<String,Object>> 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.