HalFormsDocument (Spring HATEOAS 1.0.5.RELEASE API)

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HalFormsDocument<T>`	`andEmbedded(HalLinkRelation key, Object value)` Adds the given value as embedded one.
`HalFormsDocument<T>`	`andLink(Link link)` Adds the given `Link` to the current document.
`HalFormsDocument<T>`	`andTemplate(String name, HalFormsTemplate template)` Adds the given `HalFormsTemplate` to the current document.
`static HalFormsDocument<?>`	`empty()` Creates a new empty `HalFormsDocument`.
`static <T> HalFormsDocument<T>`	`forEntities(Collection<T> entities)` returns a new `HalFormsDocument` for the given resources.
`static <T> HalFormsDocument<T>`	`forEntity(T resource)` Creates a new `HalFormsDocument` for the given resource.
`static HalFormsDocument<?>`	`forRepresentationModel(RepresentationModel<?> model)` Creates a new `HalFormsDocument` for the given resource support.
`HalFormsTemplate`	`getDefaultTemplate()` Returns the default template of the document.
`HalFormsTemplate`	`getTemplate(String key)` Returns the template with the given name.
`HalFormsDocument<T>`	`withPageMetadata(PagedModel.PageMetadata metadata)`

public static <T> HalFormsDocument<T> forEntity(@Nullable
                                                T resource)

Creates a new HalFormsDocument for the given resource.

public HalFormsDocument<T> withPageMetadata(@Nullable
                                            PagedModel.PageMetadata metadata)

public HalFormsDocument<T> andTemplate(String name,
                                       HalFormsTemplate template)

Adds the given HalFormsTemplate to the current document.

Parameters:: name - must not be null or empty.; template - must not be null.
Returns:

public HalFormsDocument<T> andEmbedded(HalLinkRelation key,
                                       Object value)

Adds the given value as embedded one.

Parameters:: key - must not be null or empty.; value - must not be null.
Returns:

Class HalFormsDocument<T>