Class HalFormsPromptedValue
java.lang.Object
org.springframework.hateoas.mediatype.hal.forms.HalFormsPromptedValue
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
-
Method Summary
Modifier and TypeMethodDescriptionReturns the prompt to be used.getValue()
Returns the value.static HalFormsPromptedValue
Creates a newHalFormsPromptedValue
with the given plain prompt and value.static HalFormsPromptedValue
Creates a newHalFormsPromptedValue
with the given prompt key to be used for i18nization and value.
-
Method Details
-
of
Creates a newHalFormsPromptedValue
with the given plain prompt and value.- Parameters:
prompt
- must not be null or empty.value
-- Returns:
-
ofI18ned
Creates a newHalFormsPromptedValue
with the given prompt key to be used for i18nization and value.- Parameters:
promptKey
- must not be null or empty.value
-- Returns:
-
getPrompt
Returns the prompt to be used. Can be a pre-resolvedString
or a value to be resolved into a String during serialization.- Returns:
- will never be null.
-
getValue
Returns the value.- Returns:
- will never be null.
-