org.springframework.hateoas.mediatype.hal.forms

Class HalFormsPromptedValue

java.lang.Object

org.springframework.hateoas.mediatype.hal.forms.HalFormsPromptedValue

public class HalFormsPromptedValue
extends Object

A value object to describe prompted values for HAL-FORMS options' inline attribute or responses of resources pointed to by the link object.

Since:

1.3

Author:

Oliver Drotbohm

See Also:

https://rwcbook.github.io/hal-forms/#options-element

Method Summary

Modifier and Type	Method and Description
Object	getPrompt() Returns the prompt to be used.
Object	getValue() Returns the value.
static HalFormsPromptedValue	of(String prompt, Object value) Creates a new HalFormsPromptedValue with the given plain prompt and value.
static HalFormsPromptedValue	ofI18ned(String promptKey, Object value) Creates a new HalFormsPromptedValue with the given prompt key to be used for i18nization and value.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static HalFormsPromptedValue of(String prompt,
                                       Object value)

Creates a new HalFormsPromptedValue with the given plain prompt and value.

Parameters:

prompt - must not be null or empty.

value -

Returns:

ofI18ned

public static HalFormsPromptedValue ofI18ned(String promptKey,
                                             Object value)

Creates a new HalFormsPromptedValue with the given prompt key to be used for i18nization and value.

Parameters:

promptKey - must not be null or empty.

value -

Returns:

getPrompt

public Object getPrompt()

Returns the prompt to be used. Can be a pre-resolved String or a value to be resolved into a String during serialization.

Returns:

will never be null.

getValue

public Object getValue()

Returns the value.

Returns:

will never be null.