org.springframework.hateoas.mediatype.hal.forms

Class HalFormsTemplate

java.lang.Object

org.springframework.hateoas.mediatype.hal.forms.HalFormsTemplate

public class HalFormsTemplate
extends Object

Value object for a HAL-FORMS template. Describes the available state transition details.

Author:

Dietrich Schulten, Greg Turnquist

See Also:

https://rwcbook.github.io/hal-forms/#_the_code__templates_code_element

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_KEY

Method Summary

Modifier and Type	Method and Description
HalFormsTemplate	andContentType(MediaType mediaType) Returns a new HalFormsTemplate with the given MediaType added as content type.
HalFormsTemplate	andProperty(HalFormsProperty property) Returns a new HalFormsTemplate with the given HalFormsProperty added.
static HalFormsTemplate	forMethod(HttpMethod httpMethod)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_KEY

public static final String DEFAULT_KEY

See Also:

Constant Field Values

Method Detail

forMethod

public static HalFormsTemplate forMethod(HttpMethod httpMethod)

andProperty

public HalFormsTemplate andProperty(HalFormsProperty property)

Returns a new HalFormsTemplate with the given HalFormsProperty added.

Parameters:

property - must not be null.

Returns:

andContentType

public HalFormsTemplate andContentType(MediaType mediaType)

Returns a new HalFormsTemplate with the given MediaType added as content type.

Parameters:

mediaType - must not be null.

Returns: