HalXmlRenderer (Grace Framework

grails.rest.render.hal.HalXmlRenderer

```
@CompileStatic
class HalXmlRenderer<T>
extends AbstractLinkingRenderer<T>
```
Renders domain instances in HAL XML format (see http://stateless.co/hal_specification.html)
Authors:
Graeme Rocher
Since:
2.3

Field Summary

Fields
Modifiers	Name	Description
`static String`	`LINK_TAG`
`static MimeType`	`MIME_TYPE`
`static String`	`RELATIONSHIP_ATTRIBUTE`
`static String`	`RESOURCE_TAG`

Constructor Summary

Constructors
Constructor and description
`HalXmlRenderer(Class<T> targetType)`
`HalXmlRenderer(Class<T> targetType, MimeType mimeType)`
`HalXmlRenderer(Class<T> targetType, MimeType[] mimeTypes)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`renderInternal(T object, RenderContext context)`
	`protected void`	`startResourceTag(XMLStreamWriter writer, String resourceHref, Locale locale, String title)`
	`protected void`	`startResourceTagForCurrentPath(RenderContext context, XMLStreamWriter writer)`
	`protected void`	`writeDomainProperty(Object value, String propertyName, Object writerObject)`
	`protected void`	`writeDomainWithEmbeddedAndLinks(PersistentEntity entity, Object object, RenderContext context, XML xml, Set writtenObjects)`
	`void`	`writeLink(Link link, Locale locale, Object writerObject)`

- Field Detail
  - public static final String LINK_TAG
  - public static final MimeType MIME_TYPE
  - public static final String RELATIONSHIP_ATTRIBUTE
  - public static final String RESOURCE_TAG
- Constructor Detail
  - HalXmlRenderer(Class<T> targetType)
  - HalXmlRenderer(Class<T> targetType, MimeType mimeType)
  - HalXmlRenderer(Class<T> targetType, MimeType[] mimeTypes)
- Method Detail
  - @Override
    void renderInternal(T object, RenderContext context)
  - protected void startResourceTag(XMLStreamWriter writer, String resourceHref, Locale locale, String title)
  - protected void startResourceTagForCurrentPath(RenderContext context, XMLStreamWriter writer)
  - @Override
    protected void writeDomainProperty(Object value, String propertyName, Object writerObject)
  - protected void writeDomainWithEmbeddedAndLinks(PersistentEntity entity, Object object, RenderContext context, XML xml, Set writtenObjects)
  - @Override
    void writeLink(Link link, Locale locale, Object writerObject)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Groovy] Class HalXmlRenderer<T>

Field Summary

Constructor Summary

Methods Summary

Field Detail

public static final String LINK_TAG

public static final MimeType MIME_TYPE

public static final String RELATIONSHIP_ATTRIBUTE

public static final String RESOURCE_TAG

Constructor Detail

HalXmlRenderer(Class<T> targetType)

HalXmlRenderer(Class<T> targetType, MimeType mimeType)

HalXmlRenderer(Class<T> targetType, MimeType[] mimeTypes)

Method Detail

@Override
void renderInternal(T object, RenderContext context)

protected void startResourceTag(XMLStreamWriter writer, String resourceHref, Locale locale, String title)

protected void startResourceTagForCurrentPath(RenderContext context, XMLStreamWriter writer)

@Override
protected void writeDomainProperty(Object value, String propertyName, Object writerObject)

protected void writeDomainWithEmbeddedAndLinks(PersistentEntity entity, Object object, RenderContext context, XML xml, Set writtenObjects)

@Override
void writeLink(Link link, Locale locale, Object writerObject)

[Groovy] Class HalXmlRenderer<T>

Field Summary

Constructor Summary

Methods Summary

Field Detail

public static final String LINK_TAG

public static final MimeType MIME_TYPE

public static final String RELATIONSHIP_ATTRIBUTE

public static final String RESOURCE_TAG

Constructor Detail

HalXmlRenderer(Class<T> targetType)

HalXmlRenderer(Class<T> targetType, MimeType mimeType)

HalXmlRenderer(Class<T> targetType, MimeType[] mimeTypes)

Method Detail

@Overridevoid renderInternal(T object, RenderContext context)

protected void startResourceTag(XMLStreamWriter writer, String resourceHref, Locale locale, String title)

protected void startResourceTagForCurrentPath(RenderContext context, XMLStreamWriter writer)

@Overrideprotected void writeDomainProperty(Object value, String propertyName, Object writerObject)

protected void writeDomainWithEmbeddedAndLinks(PersistentEntity entity, Object object, RenderContext context, XML xml, Set writtenObjects)

@Overridevoid writeLink(Link link, Locale locale, Object writerObject)

@Override
void renderInternal(T object, RenderContext context)

@Override
protected void writeDomainProperty(Object value, String propertyName, Object writerObject)

@Override
void writeLink(Link link, Locale locale, Object writerObject)