grails.converters

Class XML

java.lang.Object

org.codehaus.groovy.grails.web.converters.AbstractConverter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

grails.converters.XML

All Implemented Interfaces:

org.codehaus.groovy.grails.web.converters.ConfigurableConverter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>, Converter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>, org.codehaus.groovy.grails.web.converters.IncludeExcludeConverter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

Direct Known Subclasses:

XML

public class XML
extends AbstractConverter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>
implements org.codehaus.groovy.grails.web.converters.IncludeExcludeConverter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

A converter that converts domain classes to XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XML.Builder

Nested classes/interfaces inherited from interface org.codehaus.groovy.grails.web.converters.Converter

Converter.CircularReferenceBehaviour

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	log

Fields inherited from class org.codehaus.groovy.grails.web.converters.AbstractConverter

contentType, excludes, includes

Fields inherited from interface org.codehaus.groovy.grails.web.converters.Converter

DEFAULT_REQUEST_ENCODING

Constructor Summary

Constructors

Constructor and Description
XML()
XML(java.lang.Object target)
XML(org.codehaus.groovy.grails.web.xml.XMLStreamWriter writer)

Method Summary

Modifier and Type	Method and Description
XML	attribute(java.lang.String name, java.lang.String value)
void	build(groovy.lang.Closure c)
XML	chars(java.lang.String chars)
void	convertAnother(java.lang.Object o)
static void	createNamedConfig(java.lang.String name, groovy.lang.Closure<?> callable)
XML	end()
int	getDepth()
java.lang.String	getElementName(java.lang.Object o)
static ConverterConfiguration<XML>	getNamedConfig(java.lang.String configName)
org.codehaus.groovy.grails.web.xml.StreamingMarkupWriter	getStream()
org.codehaus.groovy.grails.web.xml.XMLStreamWriter	getWriter()
protected void	handleCircularRelationship(java.lang.Object o)
protected ConverterConfiguration<XML>	initConfig()
ObjectMarshaller<XML>	lookupObjectMarshaller(java.lang.Object target)
static java.lang.Object	parse(javax.servlet.http.HttpServletRequest request) Parses the give XML (read from the POST Body of the Request)
static java.lang.Object	parse(java.io.InputStream is, java.lang.String encoding) Parses the given XML
static java.lang.Object	parse(java.lang.String source) Parses the given XML
static void	registerObjectMarshaller(java.lang.Class<?> clazz, groovy.lang.Closure<?> callable)
static void	registerObjectMarshaller(java.lang.Class<?> clazz, int priority, groovy.lang.Closure<?> callable)
static void	registerObjectMarshaller(ObjectMarshaller<XML> om)
static void	registerObjectMarshaller(ObjectMarshaller<XML> om, int priority)
void	render(javax.servlet.http.HttpServletResponse response) Marshalls the target and writes it a HttpServletResponse The response will be comitted after this operation
void	render(java.io.Writer out) Marshalls the target and writes it to a java.io.Writer
void	setExcludes(java.util.List<java.lang.String> excludes)
void	setIncludes(java.util.List<java.lang.String> includes)
void	setTarget(java.lang.Object target)
XML	startNode(java.lang.String tagName)
java.lang.String	toString()
static void	use(java.lang.String cfgName)
static java.lang.Object	use(java.lang.String configName, groovy.lang.Closure<?> callable)
static void	withDefaultConfiguration(groovy.lang.Closure<?> callable)

Methods inherited from class org.codehaus.groovy.grails.web.converters.AbstractConverter

createBeanWrapper, getExcludes, getIncludes, setContentType, setEncoding, setExcludes, setIncludes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.groovy.grails.web.converters.ConfigurableConverter

getExcludes, getIncludes, setContentType, setEncoding, setExcludes, setIncludes

Field Detail

log

public static final org.apache.commons.logging.Log log

Constructor Detail

XML

public XML()

XML

public XML(java.lang.Object target)

XML

public XML(org.codehaus.groovy.grails.web.xml.XMLStreamWriter writer)

Method Detail

initConfig

protected ConverterConfiguration<XML> initConfig()

setTarget

public void setTarget(java.lang.Object target)

Specified by:

setTarget in class AbstractConverter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

render

public void render(java.io.Writer out)
            throws ConverterException

Description copied from interface: Converter

Marshalls the target and writes it to a java.io.Writer

Specified by:

render in interface Converter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

Parameters:

out - The Writer to write to

Throws:

ConverterException

getElementName

public java.lang.String getElementName(java.lang.Object o)

convertAnother

public void convertAnother(java.lang.Object o)
                    throws ConverterException

Specified by:

convertAnother in interface Converter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

Throws:

ConverterException

lookupObjectMarshaller

public ObjectMarshaller<XML> lookupObjectMarshaller(java.lang.Object target)

Specified by:

lookupObjectMarshaller in interface Converter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

getDepth

public int getDepth()

startNode

public XML startNode(java.lang.String tagName)

chars

public XML chars(java.lang.String chars)

attribute

public XML attribute(java.lang.String name,
                     java.lang.String value)

end

public XML end()

handleCircularRelationship

protected void handleCircularRelationship(java.lang.Object o)
                                   throws ConverterException

Throws:

ConverterException

render

public void render(javax.servlet.http.HttpServletResponse response)
            throws ConverterException

Description copied from interface: Converter

Marshalls the target and writes it a HttpServletResponse The response will be comitted after this operation

Specified by:

render in interface Converter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

Parameters:

response - The response to write to

Throws:

ConverterException

getWriter

public org.codehaus.groovy.grails.web.xml.XMLStreamWriter getWriter()
                                                             throws ConverterException

Specified by:

getWriter in interface Converter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

Throws:

ConverterException

getStream

public org.codehaus.groovy.grails.web.xml.StreamingMarkupWriter getStream()

build

public void build(groovy.lang.Closure c)
           throws ConverterException

Specified by:

build in interface Converter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

Throws:

ConverterException

toString

public java.lang.String toString()

Overrides:

toString in class AbstractConverter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

parse

public static java.lang.Object parse(java.lang.String source)
                              throws ConverterException

Parses the given XML

Parameters:

source - a String containing some XML

Returns:

a groovy.util.XmlSlurper

Throws:

ConverterException

parse

public static java.lang.Object parse(java.io.InputStream is,
                                     java.lang.String encoding)
                              throws ConverterException

Parses the given XML

Parameters:

is - an InputStream to read from

encoding - the Character Encoding to use

Returns:

a groovy.util.XmlSlurper

Throws:

ConverterException

parse

public static java.lang.Object parse(javax.servlet.http.HttpServletRequest request)
                              throws ConverterException

Parses the give XML (read from the POST Body of the Request)

Parameters:

request - an HttpServletRequest

Returns:

a groovy.util.XmlSlurper

Throws:

ConverterException

getNamedConfig

public static ConverterConfiguration<XML> getNamedConfig(java.lang.String configName)
                                                  throws ConverterException

Throws:

ConverterException

use

public static java.lang.Object use(java.lang.String configName,
                                   groovy.lang.Closure<?> callable)
                            throws ConverterException

Throws:

ConverterException

use

public static void use(java.lang.String cfgName)
                throws ConverterException

Throws:

ConverterException

registerObjectMarshaller

public static void registerObjectMarshaller(java.lang.Class<?> clazz,
                                            groovy.lang.Closure<?> callable)
                                     throws ConverterException

Throws:

ConverterException

registerObjectMarshaller

public static void registerObjectMarshaller(java.lang.Class<?> clazz,
                                            int priority,
                                            groovy.lang.Closure<?> callable)
                                     throws ConverterException

Throws:

ConverterException

registerObjectMarshaller

public static void registerObjectMarshaller(ObjectMarshaller<XML> om)
                                     throws ConverterException

Throws:

ConverterException

registerObjectMarshaller

public static void registerObjectMarshaller(ObjectMarshaller<XML> om,
                                            int priority)
                                     throws ConverterException

Throws:

ConverterException

createNamedConfig

public static void createNamedConfig(java.lang.String name,
                                     groovy.lang.Closure<?> callable)
                              throws ConverterException

Throws:

ConverterException

withDefaultConfiguration

public static void withDefaultConfiguration(groovy.lang.Closure<?> callable)
                                     throws ConverterException

Throws:

ConverterException

setIncludes

public void setIncludes(java.util.List<java.lang.String> includes)

Specified by:

setIncludes in interface org.codehaus.groovy.grails.web.converters.IncludeExcludeConverter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>

setExcludes

public void setExcludes(java.util.List<java.lang.String> excludes)

Specified by:

setExcludes in interface org.codehaus.groovy.grails.web.converters.IncludeExcludeConverter<org.codehaus.groovy.grails.web.xml.XMLStreamWriter>