org.springframework.hateoas.mediatype.hal.forms

Class HalFormsProperty

java.lang.Object

org.springframework.hateoas.mediatype.hal.forms.HalFormsProperty

All Implemented Interfaces:

AffordanceModel.Named, AffordanceModel.PropertyMetadataConfigured<HalFormsProperty>

public class HalFormsProperty
extends Object
implements AffordanceModel.PropertyMetadataConfigured<HalFormsProperty>, AffordanceModel.Named

Describe a parameter for the associated state transition in a HAL-FORMS document. A HalFormsTemplate may contain a list of HalFormsPropertys

See Also:

https://mamund.site44.com/misc/hal-forms/

Constructor Summary

Constructors

Constructor and Description
HalFormsProperty()

Method Summary

Modifier and Type	Method and Description
HalFormsProperty	apply(AffordanceModel.PropertyMetadata metadata) Applies the given AffordanceModel.PropertyMetadata.
static HalFormsProperty	named(String name) Creates a new HalFormsProperty with the given name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.hateoas.AffordanceModel.Named

getName

Constructor Detail

HalFormsProperty

public HalFormsProperty()

Method Detail

named

public static HalFormsProperty named(String name)

Creates a new HalFormsProperty with the given name.

Parameters:

name - must not be null.

Returns:

apply

public HalFormsProperty apply(AffordanceModel.PropertyMetadata metadata)

Description copied from interface: AffordanceModel.PropertyMetadataConfigured

Applies the given AffordanceModel.PropertyMetadata.

Specified by:

apply in interface AffordanceModel.PropertyMetadataConfigured<HalFormsProperty>

Parameters:

metadata - will never be null.

Returns: