@groovy.transform.CompileStatic class DefaultHalViewHelper extends DefaultJsonViewHelper implements HalViewHelper
Helps creating HAL links
Modifiers | Name | Description |
---|---|---|
class |
DefaultHalViewHelper.1 |
|
static class |
DefaultHalViewHelper.HalStreamingJsonDelegate |
Modifiers | Name | Description |
---|---|---|
static java.lang.String |
EMBEDDED_ATTRIBUTE |
|
static java.lang.String |
EMBEDDED_PARAMETER |
|
static java.lang.String |
HREFLANG_ATTRIBUTE |
|
static java.lang.String |
HREF_ATTRIBUTE |
|
static java.lang.String |
LINKS_ATTRIBUTE |
|
static java.lang.String |
SELF_ATTRIBUTE |
|
static java.lang.String |
TYPE_ATTRIBUTE |
|
private java.lang.String |
contentType |
|
private StreamingJsonBuilder.StreamingJsonDelegate |
jsonDelegate |
|
private GrailsJsonViewHelper |
viewHelper |
Fields inherited from class | Fields |
---|---|
class DefaultJsonViewHelper |
ASSOCIATIONS, DEFAULT_EXCLUDES, DEFAULT_GORM_EXCLUDES, DEFAULT_VALIDATEABLE_EXCLUDES, EXPAND, NULL_OUTPUT, PAGINATION_MAX, PAGINATION_OFFSET, PAGINATION_ORDER, PAGINATION_RESROUCE, PAGINATION_SORT, PAGINATION_TOTAL, TO_STRING_TYPES, includeExcludeSupport, simpleIncludeExcludeSupport, validateableIncludeExcludeSupport |
class DefaultGrailsViewHelper |
view |
Type | Name and description |
---|---|
java.lang.String |
contentType |
GrailsJsonViewHelper |
viewHelper |
Constructor and description |
---|
DefaultHalViewHelper
(JsonView view, GrailsJsonViewHelper viewHelper) |
Type Params | Return Type | Name and description |
---|---|---|
|
protected groovy.lang.Closure<java.lang.Void> |
createlinksRenderingClosure(java.util.Map<java.lang.String, java.lang.Object> arguments) |
|
void |
embedded(java.lang.Object object, java.util.Map arguments) Renders embedded associations for the given entity |
|
void |
embedded(java.util.Map model) Render the given embedded objects |
|
void |
embedded(groovy.lang.Closure callable) Outputs a HAL embedded entry for the given closure |
|
void |
embedded(java.lang.String contentType, groovy.lang.Closure callable) Outputs a HAL embedded entry for the content type and closure |
|
private java.util.Set<Link> |
getLinks(java.lang.Object o) |
|
void |
inline(java.lang.Object object, java.util.Map arguments, groovy.lang.Closure customizer) |
|
void |
inline(java.lang.Object object, groovy.lang.Closure customizer) |
|
void |
links(groovy.lang.Closure callable) Define the hal links |
|
void |
links(java.lang.Object object, java.lang.String contentType) Creates HAL links for the given object |
|
void |
links(java.util.Map model, java.lang.Object paginationObject, java.lang.Number total, java.lang.String contentType) |
|
void |
links(java.util.Map model, java.lang.String contentType) |
|
void |
paginate(java.lang.Object object, java.lang.Integer total, java.lang.Integer offset, java.lang.Integer max, java.lang.String sort, java.lang.String order) |
|
JsonWritable |
render(java.lang.Object object, java.util.Map arguments, groovy.lang.Closure customizer) Same as GrailsJsonViewHelper#render(java.lang.Object, java.util.Map, groovy.lang.Closure) but renders HAL links too |
|
JsonWritable |
render(java.lang.Object object, java.util.Map arguments) |
|
JsonWritable |
render(java.lang.Object object, groovy.lang.Closure customizer) Same as GrailsJsonViewHelper#render(java.lang.Object, java.util.Map, groovy.lang.Closure) but renders HAL links too |
|
JsonWritable |
render(java.lang.Object object) |
|
protected void |
renderEntityProperties(PersistentEntity entity, java.lang.Object instance, EntityReflector entityReflector, StreamingJsonBuilder.StreamingJsonDelegate associationJsonDelegate) |
|
protected void |
renderProperty(java.lang.Object embeddedObject, PersistentProperty prop, EntityReflector associationReflector, StreamingJsonDelegate jsonDelegate) |
|
void |
setDelegate(StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate) |
|
void |
type(java.lang.String name)
|
|
protected void |
writeLinks(StreamingJsonBuilder.StreamingJsonDelegate jsonDelegate, java.lang.Object object, java.lang.String contentType) |
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 |
Renders embedded associations for the given entity
object
- The objectarguments
- Any arguments. Supported arguments: 'includes', 'excludes', 'deep'Render the given embedded objects
model
- The embedded modelOutputs a HAL embedded entry for the given closure
callable
- The callableOutputs a HAL embedded entry for the content type and closure
callable
- The callableDefine the hal links
callable
- The closureCreates HAL links for the given object
object
- The object to create links forSame as GrailsJsonViewHelper#render(java.lang.Object, java.util.Map, groovy.lang.Closure) but renders HAL links too
Same as GrailsJsonViewHelper#render(java.lang.Object, java.util.Map, groovy.lang.Closure) but renders HAL links too
name
- Sets the HAL response typeGroovy Documentation