org.codehaus.groovy.grails.web.converters.marshaller.xml

Class DomainClassMarshaller

java.lang.Object

org.codehaus.groovy.grails.web.converters.marshaller.IncludeExcludePropertyMarshaller<XML>

org.codehaus.groovy.grails.web.converters.marshaller.xml.DomainClassMarshaller

All Implemented Interfaces:

ObjectMarshaller<XML>

Direct Known Subclasses:

DeepDomainClassMarshaller

public class DomainClassMarshaller
extends IncludeExcludePropertyMarshaller<XML>

Object marshaller for domain classes to XML

Since:

1.1

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.groovy.grails.commons.GrailsApplication	application
protected boolean	includeVersion
protected org.codehaus.groovy.grails.support.proxy.ProxyHandler	proxyHandler

Constructor Summary

Constructors

Constructor and Description
DomainClassMarshaller(boolean includeVersion, org.codehaus.groovy.grails.commons.GrailsApplication application)
DomainClassMarshaller(boolean includeVersion, org.codehaus.groovy.grails.support.proxy.ProxyHandler proxyHandler, org.codehaus.groovy.grails.commons.GrailsApplication application)
DomainClassMarshaller(org.codehaus.groovy.grails.commons.GrailsApplication application)

Method Summary

Modifier and Type	Method and Description
protected void	asShortObject(java.lang.Object refObj, XML xml, org.codehaus.groovy.grails.commons.GrailsDomainClassProperty idProperty, org.codehaus.groovy.grails.commons.GrailsDomainClass referencedDomainClass)
protected boolean	isRenderDomainClassRelations()
void	marshalObject(java.lang.Object value, XML xml) Performs the conversion
protected boolean	shouldInitializeProxies()
boolean	supports(java.lang.Object object) Checks wheter the ObjectMarshaller is able/intended to support the given Object

Methods inherited from class org.codehaus.groovy.grails.web.converters.marshaller.IncludeExcludePropertyMarshaller

excludesProperty, includesProperty, shouldInclude

Methods inherited from class java.lang.Object

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

Field Detail

includeVersion

protected final boolean includeVersion

proxyHandler

protected org.codehaus.groovy.grails.support.proxy.ProxyHandler proxyHandler

application

protected org.codehaus.groovy.grails.commons.GrailsApplication application

Constructor Detail

DomainClassMarshaller

public DomainClassMarshaller(org.codehaus.groovy.grails.commons.GrailsApplication application)

DomainClassMarshaller

public DomainClassMarshaller(boolean includeVersion,
                             org.codehaus.groovy.grails.commons.GrailsApplication application)

DomainClassMarshaller

public DomainClassMarshaller(boolean includeVersion,
                             org.codehaus.groovy.grails.support.proxy.ProxyHandler proxyHandler,
                             org.codehaus.groovy.grails.commons.GrailsApplication application)

Method Detail

supports

public boolean supports(java.lang.Object object)

Description copied from interface: ObjectMarshaller

Checks wheter the ObjectMarshaller is able/intended to support the given Object

Parameters:

object - the object which is about getting converted

Returns:

true if the marshaller can/should perform the marshalling, false otherwise

marshalObject

public void marshalObject(java.lang.Object value,
                          XML xml)
                   throws ConverterException

Description copied from interface: ObjectMarshaller

Performs the conversion

Parameters:

value - the object which is about getting converted

xml - the Converter to use

Throws:

ConverterException - on failure

shouldInitializeProxies

protected boolean shouldInitializeProxies()

asShortObject

protected void asShortObject(java.lang.Object refObj,
                             XML xml,
                             org.codehaus.groovy.grails.commons.GrailsDomainClassProperty idProperty,
                             org.codehaus.groovy.grails.commons.GrailsDomainClass referencedDomainClass)
                      throws ConverterException

Throws:

ConverterException

isRenderDomainClassRelations

protected boolean isRenderDomainClassRelations()