DefaultHalViewHelper (Grace Framework

org.grails.views.json.api.internal.DefaultHalViewHelper

All Implemented Interfaces and Traits:

HalViewHelper
```
@CompileStatic
class DefaultHalViewHelper
extends DefaultJsonViewHelper
implements HalViewHelper
```
Helps creating HAL links
Authors:
Graeme Rocher
Michael Yan
Since:
2024.0.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`DefaultHalViewHelper.1`
`static class`	`DefaultHalViewHelper.HalStreamingJsonDelegate`

Field Summary

Fields
Modifiers	Name	Description
`static String`	`EMBEDDED_ATTRIBUTE`
`static String`	`EMBEDDED_PARAMETER`
`static String`	`HREFLANG_ATTRIBUTE`
`static String`	`HREF_ATTRIBUTE`
`static String`	`LINKS_ATTRIBUTE`
`static String`	`SELF_ATTRIBUTE`
`static String`	`TYPE_ATTRIBUTE`

Inherited fields
Fields inherited from class	Fields
`class DefaultJsonViewHelper`	`DEFAULT_EXCLUDES, DEFAULT_GORM_EXCLUDES, DEFAULT_VALIDATEABLE_EXCLUDES, PAGINATION_MAX, PAGINATION_OFFSET, PAGINATION_ORDER, PAGINATION_RESROUCE, PAGINATION_SORT, PAGINATION_TOTAL, TO_STRING_TYPES`

Properties Summary

Properties
Type	Name and description
`String`	`contentType`
`GrailsJsonViewHelper`	`viewHelper`

Inherited properties
Properties inherited from class	Properties
`class DefaultJsonViewHelper`	`ASSOCIATIONS, EXPAND, includeExcludeSupport, simpleIncludeExcludeSupport, validateableIncludeExcludeSupport`
`class DefaultGrailsViewHelper`	`view`

Constructor Summary

Constructors
Constructor and description
`DefaultHalViewHelper(JsonView view, GrailsJsonViewHelper viewHelper)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected Closure<Void>`	`createlinksRenderingClosure(Map<String, Object> arguments)`
	`void`	`embedded(Object object, Map arguments)` Renders embedded associations for the given entity
	`void`	`embedded(Map model)` Render the given embedded objects
	`void`	`embedded(Closure callable)` Outputs a HAL embedded entry for the given closure
	`void`	`embedded(String contentType, Closure callable)` Outputs a HAL embedded entry for the content type and closure
	`void`	`inline(Object object, Map arguments, Closure customizer)`
	`void`	`inline(Object object, Closure customizer)`
	`void`	`links(Closure callable)` Define the hal links
	`void`	`links(Object object, String contentType)` Creates HAL links for the given object
	`void`	`links(Map model, Object paginationObject, Number total, String contentType)`
	`void`	`links(Map model, String contentType)`
	`void`	`paginate(Object object, Integer total, Integer offset, Integer max, String sort, String order)`
	`JsonWritable`	`render(Object object, Map arguments, Closure customizer)` Same as GrailsJsonViewHelper#render(java.lang.Object, java.util.Map, groovy.lang.Closure) but renders HAL links too
	`JsonWritable`	`render(Object object, Map arguments)`
	`JsonWritable`	`render(Object object, Closure customizer)` Same as GrailsJsonViewHelper#render(java.lang.Object, java.util.Map, groovy.lang.Closure) but renders HAL links too
	`JsonWritable`	`render(Object object)`
	`protected void`	`renderEntityProperties(PersistentEntity entity, Object instance, EntityReflector entityReflector, StreamingJsonBuilder.StreamingJsonDelegate associationJsonDelegate)`
	`protected void`	`renderProperty(Object embeddedObject, PersistentProperty prop, EntityReflector associationReflector, StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate)`
	`void`	`setDelegate(StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate)`
	`void`	`type(String name)` Parameters: `name` - Sets the HAL response type
	`protected void`	`writeLinks(StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate, Object object, String contentType)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DefaultJsonViewHelper`	`buildPaginateParams, defaultPaginateParams, findEntity, getExcludes, getExpandProperties, getGenerator, getGenericType, getIncludes, getJsonStackTrace, getLastOffset, getNextOffset, getPaginationLinks, getPaginationLinks, getPrevOffset, getRenderNulls, includeAssociations, isSimpleType, isStringType, paramsWithOffset`
`class DefaultGrailsViewHelper`	`ensureAbsolute, getContextPath, getLinkGenerator, getServerBaseURL, link, link, message, resource`

- Field Detail
  - public static final String EMBEDDED_ATTRIBUTE
  - public static final String EMBEDDED_PARAMETER
  - public static final String HREFLANG_ATTRIBUTE
  - public static final String HREF_ATTRIBUTE
  - public static final String LINKS_ATTRIBUTE
  - public static final String SELF_ATTRIBUTE
  - public static final String TYPE_ATTRIBUTE
- Property Detail
  - String contentType
  - GrailsJsonViewHelper viewHelper
- Constructor Detail
  - DefaultHalViewHelper(JsonView view, GrailsJsonViewHelper viewHelper)
- Method Detail
  - @CompileDynamic
    protected Closure<Void> createlinksRenderingClosure(Map<String, Object> arguments)
  - void embedded(Object object, Map arguments)
    
    Renders embedded associations for the given entity
    Parameters:
    object - The object
    arguments - Any arguments. Supported arguments: 'includes', 'excludes', 'deep'
  - @Override
    void embedded(Map model)
    
    Render the given embedded objects
    Parameters:
    model - The embedded model
  - void embedded(@DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
    Closure callable)
    
    Outputs a HAL embedded entry for the given closure
    Parameters:
    callable - The callable
  - void embedded(String contentType, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
    Closure callable)
    
    Outputs a HAL embedded entry for the content type and closure
    Parameters:
    callable - The callable
  - @Override
    void inline(Object object, Map arguments, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
    Closure customizer)
  - @Override
    void inline(Object object, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
    Closure customizer)
  - @Override
    void links(Closure callable)
    
    Define the hal links
    Parameters:
    callable - The closure
  - void links(Object object, String contentType)
    
    Creates HAL links for the given object
    Parameters:
    object - The object to create links for
  - void links(Map model, Object paginationObject, Number total, String contentType)
  - void links(Map model, String contentType)
  - void paginate(Object object, Integer total, Integer offset, Integer max, String sort, String order)
  - @Override
    JsonWritable render(Object object, Map arguments, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
    Closure customizer)
    
    Same as GrailsJsonViewHelper#render(java.lang.Object, java.util.Map, groovy.lang.Closure) but renders HAL links too
  - @Override
    JsonWritable render(Object object, Map arguments)
  - @Override
    JsonWritable render(Object object, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
    Closure customizer)
    
    Same as GrailsJsonViewHelper#render(java.lang.Object, java.util.Map, groovy.lang.Closure) but renders HAL links too
  - @Override
    JsonWritable render(Object object)
  - protected void renderEntityProperties(PersistentEntity entity, Object instance, EntityReflector entityReflector, StreamingJsonBuilder.StreamingJsonDelegate associationJsonDelegate)
  - protected void renderProperty(Object embeddedObject, PersistentProperty prop, EntityReflector associationReflector, StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate)
  - @Override
    void setDelegate(StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate)
  - @Override
    void type(String name)
    
    Parameters:
    name - Sets the HAL response type
  - protected void writeLinks(StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate, Object object, String contentType)

[Groovy] Class DefaultHalViewHelper

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String EMBEDDED_ATTRIBUTE

public static final String EMBEDDED_PARAMETER

public static final String HREFLANG_ATTRIBUTE

public static final String HREF_ATTRIBUTE

public static final String LINKS_ATTRIBUTE

public static final String SELF_ATTRIBUTE

public static final String TYPE_ATTRIBUTE

Property Detail

String contentType

GrailsJsonViewHelper viewHelper

Constructor Detail

DefaultHalViewHelper(JsonView view, GrailsJsonViewHelper viewHelper)

Method Detail

@CompileDynamicprotected Closure<Void> createlinksRenderingClosure(Map<String, Object> arguments)

void embedded(Object object, Map arguments)

@Overridevoid embedded(Map model)

void embedded(@DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)Closure callable)

void embedded(String contentType, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)Closure callable)

@Overridevoid inline(Object object, Map arguments, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)Closure customizer)

@Overridevoid inline(Object object, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)Closure customizer)

@Overridevoid links(Closure callable)

void links(Object object, String contentType)

void links(Map model, Object paginationObject, Number total, String contentType)

void links(Map model, String contentType)

void paginate(Object object, Integer total, Integer offset, Integer max, String sort, String order)

@OverrideJsonWritable render(Object object, Map arguments, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)Closure customizer)

@OverrideJsonWritable render(Object object, Map arguments)

@OverrideJsonWritable render(Object object, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)Closure customizer)

@OverrideJsonWritable render(Object object)

protected void renderEntityProperties(PersistentEntity entity, Object instance, EntityReflector entityReflector, StreamingJsonBuilder.StreamingJsonDelegate associationJsonDelegate)

protected void renderProperty(Object embeddedObject, PersistentProperty prop, EntityReflector associationReflector, StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate)

@Overridevoid setDelegate(StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate)

@Overridevoid type(String name)

protected void writeLinks(StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate, Object object, String contentType)

@CompileDynamic
protected Closure<Void> createlinksRenderingClosure(Map<String, Object> arguments)

@Override
void embedded(Map model)

void embedded(@DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
Closure callable)

void embedded(String contentType, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
Closure callable)

@Override
void inline(Object object, Map arguments, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
Closure customizer)

@Override
void inline(Object object, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
Closure customizer)

@Override
void links(Closure callable)

@Override
JsonWritable render(Object object, Map arguments, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
Closure customizer)

@Override
JsonWritable render(Object object, Map arguments)

@Override
JsonWritable render(Object object, @DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate)
Closure customizer)

@Override
JsonWritable render(Object object)

@Override
void setDelegate(StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate)

@Override
void type(String name)