Groovy 1.6.4

groovy.xml
Class MarkupBuilder

java.lang.Object
  groovy.lang.GroovyObjectSupport
      groovy.util.BuilderSupport
          groovy.xml.MarkupBuilder

class MarkupBuilder
extends BuilderSupport

A helper class for creating XML or HTML markup

author:
James Strachan
author:
Stefan Matthias Aust
author:
Scott Stirling
author:
Paul King
version:
$Revision: 14219 $


Constructor Summary
MarkupBuilder()

MarkupBuilder(PrintWriter writer)

MarkupBuilder(Writer writer)

MarkupBuilder(IndentPrinter out)

 
Method Summary
protected Object createNode(Object name)

protected Object createNode(Object name, Object value)

protected Object createNode(Object name, Map attributes, Object value)

protected Object createNode(Object name, Map attributes)

boolean getDoubleQuotes()

Returns true if attribute values are output with double quotes; false if single quotes are used.

Object getMkp()

protected Object getName(String methodName)

protected IndentPrinter getPrinter()

boolean isOmitEmptyAttributes()

Determine whether empty attributes will appear in the produced markup.

boolean isOmitNullAttributes()

Determine whether null attributes will appear in the produced markup.

protected void nodeCompleted(Object parent, Object node)

protected void print(Object node)

void setDoubleQuotes(boolean useDoubleQuotes)

Sets whether the builder outputs attribute values in double quotes or single quotes.

void setOmitEmptyAttributes(boolean omitEmptyAttributes)

Allows empty attributes to be removed the produced markup.

void setOmitNullAttributes(boolean omitNullAttributes)

Allows null attributes to be removed the produced markup.

protected void setParent(Object parent, Object child)

protected String transformValue(String value)

Returns a String with special XML characters escaped as entities so that output XML is valid.

void yield(String value)

void yieldUnescaped(String value)

 
Methods inherited from class BuilderSupport
createNode, createNode, createNode, createNode, doInvokeMethod, getCurrent, getName, invokeMethod, invokeMethod, nodeCompleted, postNodeCompletion, setClosureDelegate, setCurrent, setParent
 
Methods inherited from class GroovyObjectSupport
getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty
 
Methods inherited from class Object
wait, wait, wait, hashCode, getClass, equals, toString, notify, notifyAll
 

Constructor Detail

MarkupBuilder

public MarkupBuilder()


MarkupBuilder

public MarkupBuilder(PrintWriter writer)


MarkupBuilder

public MarkupBuilder(Writer writer)


MarkupBuilder

public MarkupBuilder(IndentPrinter out)


 
Method Detail

createNode

protected Object createNode(Object name)


createNode

protected Object createNode(Object name, Object value)


createNode

protected Object createNode(Object name, Map attributes, Object value)


createNode

protected Object createNode(Object name, Map attributes)


getDoubleQuotes

public boolean getDoubleQuotes()
Returns true if attribute values are output with double quotes; false if single quotes are used. By default, single quotes are used.
return:
true if double quotes are used for attributes


getMkp

public Object getMkp()


getName

protected Object getName(String methodName)


getPrinter

protected IndentPrinter getPrinter()


isOmitEmptyAttributes

public boolean isOmitEmptyAttributes()
Determine whether empty attributes will appear in the produced markup.
return:
true, if empty attributes will be removed from the resulting markup.


isOmitNullAttributes

public boolean isOmitNullAttributes()
Determine whether null attributes will appear in the produced markup.
return:
true, if null attributes will be removed from the resulting markup.


nodeCompleted

protected void nodeCompleted(Object parent, Object node)


print

protected void print(Object node)


setDoubleQuotes

public void setDoubleQuotes(boolean useDoubleQuotes)
Sets whether the builder outputs attribute values in double quotes or single quotes.
param:
useDoubleQuotes If this parameter is true, double quotes are used; otherwise, single quotes are.


setOmitEmptyAttributes

public void setOmitEmptyAttributes(boolean omitEmptyAttributes)
Allows empty attributes to be removed the produced markup.
param:
omitEmptyAttributes if true, empty attributes will not be included in the resulting markup. Defaults to false.


setOmitNullAttributes

public void setOmitNullAttributes(boolean omitNullAttributes)
Allows null attributes to be removed the produced markup.
param:
omitNullAttributes if true, null attributes will not be included in the resulting markup. If false null attributes will be included in the markup as empty strings regardless of the omitEmptyAttribute setting. Defaults to false.


setParent

protected void setParent(Object parent, Object child)


transformValue

protected String transformValue(String value)
Returns a String with special XML characters escaped as entities so that output XML is valid. Escapes the following characters as corresponding entities:
param:
value to be searched and replaced for XML special characters.
return:
value with XML characters escaped
deprecated:
@see #escapeXmlValue(String, boolean)


yield

public void yield(String value)


yieldUnescaped

public void yieldUnescaped(String value)


 

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