XML (Grace Framework - 2023.3.1-SNAPSHOT)

grails.converters.XML

All Implemented Interfaces and Traits:

IncludeExcludeConverter
```
public class XML
extends AbstractConverter
implements IncludeExcludeConverter
```
A converter that converts domain classes to XML.
Authors:
Siegfried Puchbauer
Graeme Rocher

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`XML.Builder`

Field Summary

Fields
Modifiers	Name	Description
`static org.apache.commons.logging.Log`	`log`

Inherited fields
Fields inherited from class	Fields
`class AbstractConverter`	`contentType, encoding, excludes, includes`

Constructor Summary

Constructors
Constructor and description
`XML()`
`XML(Object target)`
`XML(XMLStreamWriter writer)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public XML`	`attribute(String name, String value)`
	`public void`	`build(Closure c)`
	`public XML`	`chars(String chars)`
	`public void`	`convertAnother(Object o)`
	`public static void`	`createNamedConfig(String name, Closure<?> callable)`
	`public XML`	`end()`
	`public int`	`getDepth()`
	`public String`	`getElementName(Object o)`
	`public static ConverterConfiguration<XML>`	`getNamedConfig(String configName)`
	`public StreamingMarkupWriter`	`getStream()`
	`public XMLStreamWriter`	`getWriter()`
	`protected void`	`handleCircularRelationship(Object o)`
	`protected ConverterConfiguration<XML>`	`initConfig()`
	`public ObjectMarshaller<XML>`	`lookupObjectMarshaller(Object target)`
	`public static GPathResult`	`parse(String source)` Parses the given XML
	`public static GPathResult`	`parse(InputStream is, String encoding)` Parses the given XML
	`public static Object`	`parse(HttpServletRequest request)` Parses the give XML (read from the POST Body of the Request)
	`public static void`	`registerObjectMarshaller(Class<?> clazz, Closure<?> callable)`
	`public static void`	`registerObjectMarshaller(Class<?> clazz, int priority, Closure<?> callable)`
	`public static void`	`registerObjectMarshaller(ObjectMarshaller<XML> om)`
	`public static void`	`registerObjectMarshaller(ObjectMarshaller<XML> om, int priority)`
	`public void`	`render(Writer out)`
	`public void`	`render(HttpServletResponse response)`
	`public void`	`setExcludes(List<String> excludes)`
	`public void`	`setIncludes(List<String> includes)`
	`public void`	`setTarget(Object target)`
	`public XML`	`startNode(String tagName)`
	`public String`	`toString()`
	`public static Object`	`use(String configName, Closure<?> callable)`
	`public static void`	`use(String cfgName)`
	`public static void`	`withDefaultConfiguration(Closure<?> callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractConverter`	`createBeanWrapper, getExcludes, getIncludes, setContentType, setEncoding, setExcludes, setIncludes, setTarget, toString, writeTo`

- Field Detail
  - public static final org.apache.commons.logging.Log log
- Constructor Detail
  - public XML()
  - public XML(Object target)
  - public XML(XMLStreamWriter writer)
- Method Detail
  - public XML attribute(String name, String value)
  - public void build(@SuppressWarnings("rawtypes")
    Closure c)
  - public XML chars(String chars)
  - public void convertAnother(Object o)
  - public static void createNamedConfig(String name, Closure<?> callable)
  - public XML end()
  - public int getDepth()
  - public String getElementName(Object o)
  - public static ConverterConfiguration<XML> getNamedConfig(String configName)
  - public StreamingMarkupWriter getStream()
  - public XMLStreamWriter getWriter()
  - @SuppressWarnings("incomplete-switch")
    protected void handleCircularRelationship(Object o)
  - protected ConverterConfiguration<XML> initConfig()
  - public ObjectMarshaller<XML> lookupObjectMarshaller(Object target)
  - public static GPathResult parse(String source)
    
    Parses the given XML
    throws:
    ConverterException
    
    Parameters:
    source - a String containing some XML
    Returns:
    a groovy.xml.XmlSlurper
  - public static GPathResult parse(InputStream is, String encoding)
    
    Parses the given XML
    throws:
    ConverterException
    
    Parameters:
    is - an InputStream to read from
    encoding - the Character Encoding to use
    Returns:
    a groovy.xml.XmlSlurper
  - public static Object parse(HttpServletRequest request)
    
    Parses the give XML (read from the POST Body of the Request)
    throws:
    ConverterException
    
    Parameters:
    request - an HttpServletRequest
    Returns:
    a groovy.xml.XmlSlurper
  - public static void registerObjectMarshaller(Class<?> clazz, Closure<?> callable)
  - public static void registerObjectMarshaller(Class<?> clazz, int priority, Closure<?> callable)
  - public static void registerObjectMarshaller(ObjectMarshaller<XML> om)
  - public static void registerObjectMarshaller(ObjectMarshaller<XML> om, int priority)
  - public void render(Writer out)
  - public void render(HttpServletResponse response)
  - @Override
    public void setExcludes(List<String> excludes)
  - @Override
    public void setIncludes(List<String> includes)
  - @Override
    public void setTarget(Object target)
  - public XML startNode(String tagName)
  - @Override
    public String toString()
  - public static Object use(String configName, Closure<?> callable)
  - public static void use(String cfgName)
  - public static void withDefaultConfiguration(Closure<?> callable)

| Detail:
Field
Constructor
Method

[Java] Class XML

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

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

Constructor Detail

public XML()

public XML(Object target)

public XML(XMLStreamWriter writer)

Method Detail

public XML attribute(String name, String value)

public void build(@SuppressWarnings("rawtypes")Closure c)

public XML chars(String chars)

public void convertAnother(Object o)

public static void createNamedConfig(String name, Closure<?> callable)

public XML end()

public int getDepth()

public String getElementName(Object o)

public static ConverterConfiguration<XML> getNamedConfig(String configName)

public StreamingMarkupWriter getStream()

public XMLStreamWriter getWriter()

@SuppressWarnings("incomplete-switch")protected void handleCircularRelationship(Object o)

protected ConverterConfiguration<XML> initConfig()

public ObjectMarshaller<XML> lookupObjectMarshaller(Object target)

public static GPathResult parse(String source)

public static GPathResult parse(InputStream is, String encoding)

public static Object parse(HttpServletRequest request)

public static void registerObjectMarshaller(Class<?> clazz, Closure<?> callable)

public static void registerObjectMarshaller(Class<?> clazz, int priority, Closure<?> callable)

public static void registerObjectMarshaller(ObjectMarshaller<XML> om)

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

public void render(Writer out)

public void render(HttpServletResponse response)

@Overridepublic void setExcludes(List<String> excludes)

@Overridepublic void setIncludes(List<String> includes)

@Overridepublic void setTarget(Object target)

public XML startNode(String tagName)

@Overridepublic String toString()

public static Object use(String configName, Closure<?> callable)

public static void use(String cfgName)

public static void withDefaultConfiguration(Closure<?> callable)

public void build(@SuppressWarnings("rawtypes")
Closure c)

@SuppressWarnings("incomplete-switch")
protected void handleCircularRelationship(Object o)

@Override
public void setExcludes(List<String> excludes)

@Override
public void setIncludes(List<String> includes)

@Override
public void setTarget(Object target)

@Override
public String toString()