HalJsonRenderer (Grace Framework

grails.rest.render.hal.HalJsonRenderer

```
@CompileStatic
class HalJsonRenderer<T>
extends AbstractLinkingRenderer<T>
```
Renders domain instances in HAL JSON format (see http://tools.ietf.org/html/draft-kelly-json-hal-05)
Authors:
Graeme Rocher
Since:
2.3

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`HalJsonRenderer.1`

Field Summary

Fields
Modifiers	Name	Description
`static String`	`EMBEDDED_ATTRIBUTE`
`static String`	`LINKS_ATTRIBUTE`
`static MimeType`	`MIME_TYPE`

Properties Summary

Properties
Type	Name and description
`String`	`collectionName`
`DataBindingSourceRegistry`	`dataBindingSourceRegistry`
`Converter<Date, String>`	`dateToStringConverter`

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`initialize()`
	`protected Object`	`renderEmbeddedAttributes(StreamingJsonBuilder.StreamingJsonDelegate writer, Object object, RenderContext context, MimeType mimeType)`
	`void`	`renderInternal(T object, RenderContext context)`
	`void`	`setDateToStringConverter(Converter<Date, String> converter)`
	`protected void`	`writeDomainProperty(Object value, String propertyName, Object jsonWriter)`
	`protected void`	`writeDomainWithEmbeddedAndLinks(RenderContext context, Class clazz, Object object, StreamingJsonBuilder.StreamingJsonDelegate writer, Locale locale, MimeType contentType, Set writtenObjects, Stack referenceStack)`
	`protected void`	`writeLink(Link link, Locale locale, Object writer)`
	`protected void`	`writeLinkForCurrentPath(RenderContext context, MimeType mimeType, StreamingJsonBuilder.StreamingJsonDelegate writer)`
	`protected Map<Association, Object>`	`writeLinks(RenderContext context, MetaClass metaClass, Object object, PersistentEntity entity, Locale locale, MimeType contentType, StreamingJsonBuilder.StreamingJsonDelegate writer, boolean associationLinks)`
	`protected void`	`writeSimpleObject(Object object, RenderContext context, StreamingJsonBuilder.StreamingJsonDelegate writer)`
	`protected Object`	`writeSimpleObjectAndLink(Object o, RenderContext context, StreamingJsonBuilder.StreamingJsonDelegate writer, MimeType mimeType)`

- Field Detail
  - public static final String EMBEDDED_ATTRIBUTE
  - public static final String LINKS_ATTRIBUTE
  - public static final MimeType MIME_TYPE
- Property Detail
  - String collectionName
  - @Autowired(required: false)
    DataBindingSourceRegistry dataBindingSourceRegistry
  - Converter<Date, String> dateToStringConverter
- Constructor Detail
  - HalJsonRenderer(Class<T> targetType)
  - HalJsonRenderer(Class<T> targetType, MimeType[] mimeTypes)
- Method Detail
  - @jakarta.annotation.PostConstruct
    void initialize()
  - protected Object renderEmbeddedAttributes(StreamingJsonBuilder.StreamingJsonDelegate writer, Object object, RenderContext context, MimeType mimeType)
  - @Override
    void renderInternal(T object, RenderContext context)
  - @Autowired(required: false)
    void setDateToStringConverter(Converter<Date, String> converter)
  - @Override
    protected void writeDomainProperty(Object value, String propertyName, Object jsonWriter)
  - protected void writeDomainWithEmbeddedAndLinks(RenderContext context, Class clazz, Object object, StreamingJsonBuilder.StreamingJsonDelegate writer, Locale locale, MimeType contentType, Set writtenObjects, Stack referenceStack)
  - @Override
    protected void writeLink(Link link, Locale locale, Object writer)
  - protected void writeLinkForCurrentPath(RenderContext context, MimeType mimeType, StreamingJsonBuilder.StreamingJsonDelegate writer)
  - protected Map<Association, Object> writeLinks(RenderContext context, MetaClass metaClass, Object object, PersistentEntity entity, Locale locale, MimeType contentType, StreamingJsonBuilder.StreamingJsonDelegate writer, boolean associationLinks)
  - protected void writeSimpleObject(Object object, RenderContext context, StreamingJsonBuilder.StreamingJsonDelegate writer)
  - protected Object writeSimpleObjectAndLink(Object o, RenderContext context, StreamingJsonBuilder.StreamingJsonDelegate writer, MimeType mimeType)

[Groovy] Class HalJsonRenderer<T>

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Field Detail

public static final String EMBEDDED_ATTRIBUTE

public static final String LINKS_ATTRIBUTE

public static final MimeType MIME_TYPE

Property Detail

String collectionName

@Autowired(required: false)
DataBindingSourceRegistry dataBindingSourceRegistry

Converter<Date, String> dateToStringConverter

Constructor Detail

HalJsonRenderer(Class<T> targetType)

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

Method Detail

@jakarta.annotation.PostConstruct
void initialize()

protected Object renderEmbeddedAttributes(StreamingJsonBuilder.StreamingJsonDelegate writer, Object object, RenderContext context, MimeType mimeType)

@Override
void renderInternal(T object, RenderContext context)

@Autowired(required: false)
void setDateToStringConverter(Converter<Date, String> converter)

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

protected void writeDomainWithEmbeddedAndLinks(RenderContext context, Class clazz, Object object, StreamingJsonBuilder.StreamingJsonDelegate writer, Locale locale, MimeType contentType, Set writtenObjects, Stack referenceStack)

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

protected void writeLinkForCurrentPath(RenderContext context, MimeType mimeType, StreamingJsonBuilder.StreamingJsonDelegate writer)

protected Map<Association, Object> writeLinks(RenderContext context, MetaClass metaClass, Object object, PersistentEntity entity, Locale locale, MimeType contentType, StreamingJsonBuilder.StreamingJsonDelegate writer, boolean associationLinks)

protected void writeSimpleObject(Object object, RenderContext context, StreamingJsonBuilder.StreamingJsonDelegate writer)

protected Object writeSimpleObjectAndLink(Object o, RenderContext context, StreamingJsonBuilder.StreamingJsonDelegate writer, MimeType mimeType)

[Groovy] Class HalJsonRenderer<T>

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Field Detail

public static final String EMBEDDED_ATTRIBUTE

public static final String LINKS_ATTRIBUTE

public static final MimeType MIME_TYPE

Property Detail

String collectionName

@Autowired(required: false)DataBindingSourceRegistry dataBindingSourceRegistry

Converter<Date, String> dateToStringConverter

Constructor Detail

HalJsonRenderer(Class<T> targetType)

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

Method Detail

@jakarta.annotation.PostConstructvoid initialize()

protected Object renderEmbeddedAttributes(StreamingJsonBuilder.StreamingJsonDelegate writer, Object object, RenderContext context, MimeType mimeType)

@Overridevoid renderInternal(T object, RenderContext context)

@Autowired(required: false)void setDateToStringConverter(Converter<Date, String> converter)

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

protected void writeDomainWithEmbeddedAndLinks(RenderContext context, Class clazz, Object object, StreamingJsonBuilder.StreamingJsonDelegate writer, Locale locale, MimeType contentType, Set writtenObjects, Stack referenceStack)

@Overrideprotected void writeLink(Link link, Locale locale, Object writer)

protected void writeLinkForCurrentPath(RenderContext context, MimeType mimeType, StreamingJsonBuilder.StreamingJsonDelegate writer)

protected Map<Association, Object> writeLinks(RenderContext context, MetaClass metaClass, Object object, PersistentEntity entity, Locale locale, MimeType contentType, StreamingJsonBuilder.StreamingJsonDelegate writer, boolean associationLinks)

protected void writeSimpleObject(Object object, RenderContext context, StreamingJsonBuilder.StreamingJsonDelegate writer)

protected Object writeSimpleObjectAndLink(Object o, RenderContext context, StreamingJsonBuilder.StreamingJsonDelegate writer, MimeType mimeType)

@Autowired(required: false)
DataBindingSourceRegistry dataBindingSourceRegistry

@jakarta.annotation.PostConstruct
void initialize()

@Override
void renderInternal(T object, RenderContext context)

@Autowired(required: false)
void setDateToStringConverter(Converter<Date, String> converter)

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

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