AbstractLinkingRenderer (Grails 4.1.0.M1)

grails.rest.render.util.AbstractLinkingRenderer

Abstract base class for HAL renderers
Authors:
Graeme Rocher
Since:
2.3

Field Summary

Fields
Modifiers	Name	Description
`protected static java.util.List`	`DEFAULT_EXCLUDES`
`static java.lang.String`	`DEPRECATED_ATTRIBUTE`
`static java.lang.String`	`HREFLANG_ATTRIBUTE`
`static java.lang.String`	`HREF_ATTRIBUTE`
`static java.lang.String`	`RELATIONSHIP_SELF`
`static java.lang.String`	`TEMPLATED_ATTRIBUTE`
`static java.lang.String`	`TITLE_ATTRIBUTE`
`static java.lang.String`	`TYPE_ATTRIBUTE`

Properties Summary

Properties
Type	Name and description
`private boolean`	`absoluteLinks`
`private java.lang.String`	`encoding`
`private GrailsConventionGroovyPageLocator`	`groovyPageLocator`
`private LinkGenerator`	`linkGenerator`
`private MappingContext`	`mappingContext`
`private MessageSource`	`messageSource`
`private boolean`	`prettyPrint`
`private ProxyHandler`	`proxyHandler`
`private RendererRegistry`	`rendererRegistry`

Constructor Summary

Constructors
Constructor and description
`AbstractLinkingRenderer (java.lang.Class targetType, MimeType mimeType)`
`AbstractLinkingRenderer (java.lang.Class targetType, MimeType[] mimeTypes)`
`AbstractLinkingRenderer ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.lang.String`	`getLinkTitle(PersistentEntity entity, Locale locale)`
	`Collection`	`getLinksForObject(java.lang.Object object)`
	`protected java.lang.String`	`getResourceTitle(java.lang.String uri, Locale locale)`
	`protected boolean`	`isDomainResource(java.lang.Class clazz)`
	`void`	`render(T object, RenderContext context)`
	`void`	`renderInternal(T object, RenderContext context)`
	`protected Map`	`writeAssociationLinks(RenderContext context, java.lang.Object object, Locale locale, java.lang.Object writer, PersistentEntity entity, groovy.lang.MetaClass metaClass)`
	`protected void`	`writeDomain(RenderContext context, groovy.lang.MetaClass metaClass, PersistentEntity entity, java.lang.Object object, java.lang.Object writer)` Writes a domain instance Parameters: `clazz` - The class `object` - The object `writer` - The writer Returns: Any associations embedded within the object
	`protected void`	`writeDomainProperty(java.lang.Object value, java.lang.String propertyName, java.lang.Object writer)`
	`protected void`	`writeExtraLinks(java.lang.Object object, Locale locale, java.lang.Object writer)`
	`protected void`	`writeLink(Link link, Locale locale, java.lang.Object writerObject)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractIncludeExcludeRenderer`	`excludesProperty, includesProperty, shouldIncludeProperty`

- Field Detail
  - protected static java.util.List DEFAULT_EXCLUDES
  - public static final java.lang.String DEPRECATED_ATTRIBUTE
  - public static final java.lang.String HREFLANG_ATTRIBUTE
  - public static final java.lang.String HREF_ATTRIBUTE
  - public static final java.lang.String RELATIONSHIP_SELF
  - public static final java.lang.String TEMPLATED_ATTRIBUTE
  - public static final java.lang.String TITLE_ATTRIBUTE
  - public static final java.lang.String TYPE_ATTRIBUTE
- Property Detail
  - private boolean absoluteLinks
  - private java.lang.String encoding
  - private GrailsConventionGroovyPageLocator groovyPageLocator
  - private LinkGenerator linkGenerator
  - private MappingContext mappingContext
  - private MessageSource messageSource
  - private boolean prettyPrint
  - private ProxyHandler proxyHandler
  - private RendererRegistry rendererRegistry
- Constructor Detail
  - AbstractLinkingRenderer(java.lang.Class targetType, MimeType mimeType)
  - AbstractLinkingRenderer(java.lang.Class targetType, MimeType[] mimeTypes)
  - AbstractLinkingRenderer()
- Method Detail
  - protected java.lang.String getLinkTitle(PersistentEntity entity, Locale locale)
  - @groovy.transform.CompileStaticCompileStatic Collection getLinksForObject(java.lang.Object object)
  - protected java.lang.String getResourceTitle(java.lang.String uri, Locale locale)
  - protected boolean isDomainResource(java.lang.Class clazz)
  - @java.lang.OverrideOverride final void render(T object, RenderContext context)
  - void renderInternal(T object, RenderContext context)
  - protected Map writeAssociationLinks(RenderContext context, java.lang.Object object, Locale locale, java.lang.Object writer, PersistentEntity entity, groovy.lang.MetaClass metaClass)
  - protected void writeDomain(RenderContext context, groovy.lang.MetaClass metaClass, PersistentEntity entity, java.lang.Object object, java.lang.Object writer)
    
    Writes a domain instance
    Parameters:
    clazz - The class
    object - The object
    writer - The writer
    Returns:
    Any associations embedded within the object
  - protected void writeDomainProperty(java.lang.Object value, java.lang.String propertyName, java.lang.Object writer)
  - protected void writeExtraLinks(java.lang.Object object, Locale locale, java.lang.Object writer)
  - protected void writeLink(Link link, Locale locale, java.lang.Object writerObject)

Summary:
Field
Property
Constructor
Method

[Groovy] Class AbstractLinkingRenderer<T>

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static java.util.List DEFAULT_EXCLUDES

public static final java.lang.String DEPRECATED_ATTRIBUTE

public static final java.lang.String HREFLANG_ATTRIBUTE

public static final java.lang.String HREF_ATTRIBUTE

public static final java.lang.String RELATIONSHIP_SELF

public static final java.lang.String TEMPLATED_ATTRIBUTE

public static final java.lang.String TITLE_ATTRIBUTE

public static final java.lang.String TYPE_ATTRIBUTE

Property Detail

private boolean absoluteLinks

private java.lang.String encoding

private GrailsConventionGroovyPageLocator groovyPageLocator

private LinkGenerator linkGenerator

private MappingContext mappingContext

private MessageSource messageSource

private boolean prettyPrint

private ProxyHandler proxyHandler

private RendererRegistry rendererRegistry

Constructor Detail

AbstractLinkingRenderer(java.lang.Class targetType, MimeType mimeType)

AbstractLinkingRenderer(java.lang.Class targetType, MimeType[] mimeTypes)

AbstractLinkingRenderer()

Method Detail

protected java.lang.String getLinkTitle(PersistentEntity entity, Locale locale)

@groovy.transform.CompileStaticCompileStatic Collection getLinksForObject(java.lang.Object object)

protected java.lang.String getResourceTitle(java.lang.String uri, Locale locale)

protected boolean isDomainResource(java.lang.Class clazz)

@java.lang.OverrideOverride final void render(T object, RenderContext context)

void renderInternal(T object, RenderContext context)

protected Map writeAssociationLinks(RenderContext context, java.lang.Object object, Locale locale, java.lang.Object writer, PersistentEntity entity, groovy.lang.MetaClass metaClass)

protected void writeDomain(RenderContext context, groovy.lang.MetaClass metaClass, PersistentEntity entity, java.lang.Object object, java.lang.Object writer)

protected void writeDomainProperty(java.lang.Object value, java.lang.String propertyName, java.lang.Object writer)

protected void writeExtraLinks(java.lang.Object object, Locale locale, java.lang.Object writer)

protected void writeLink(Link link, Locale locale, java.lang.Object writerObject)