Package org.springframework.hateoas.mediatype.hal.forms

Interface HalFormsOptions

All Known Implementing Classes:

HalFormsOptions.AbstractHalFormsOptions, HalFormsOptions.Inline, HalFormsOptions.Remote

public interface HalFormsOptions

Representation of HAL-FORMS options attribute.

Since:

1.3

Author:

Oliver Drotbohm, Réda Housni Alaoui

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HalFormsOptions.AbstractHalFormsOptions<T extends HalFormsOptions.AbstractHalFormsOptions<T>>
static class	HalFormsOptions.Inline
static class	HalFormsOptions.Remote	Representation of a remote options element.

Method Summary

Modifier and Type	Method	Description
Long	getMaxItems()	Returns the maximum number of items to be selected.
Long	getMinItems()	Returns the minimum number of items to be selected.
String	getPromptField()	The field to look up the prompt from.
Object	getSelectedValue()
String	getValueField()	The field to use as the value to be sent.
static HalFormsOptions.Inline	inline(Collection<? extends Object> values)	Creates a new HalFormsOptions.Inline options representation listing the given collection of values.
static <T> HalFormsOptions.Inline	inline(T... values)	Creates a new HalFormsOptions.Inline options representation listing the given values.
static HalFormsOptions.Remote	remote(String href)	Creates a new HalFormsOptions.Remote options representation using the given href.
static HalFormsOptions.Remote	remote(Link link)	Creates a new HalFormsOptions.Remote options representation using the given Link.

Method Details

inline

@SafeVarargs
static <T> HalFormsOptions.Inline inline(T... values)

Creates a new HalFormsOptions.Inline options representation listing the given values.

Parameters:

values - must not be null.

Returns:

will never be null.

inline

static HalFormsOptions.Inline inline(Collection<? extends Object> values)

Creates a new HalFormsOptions.Inline options representation listing the given collection of values.

Parameters:

values - must not be null.

Returns:

will never be null.

remote

static HalFormsOptions.Remote remote(Link link)

Creates a new HalFormsOptions.Remote options representation using the given Link.

Parameters:

link - must not be null.

Returns:

will never be null.

remote

static HalFormsOptions.Remote remote(String href)

Creates a new HalFormsOptions.Remote options representation using the given href.

Parameters:

href - must not be null.

Returns:

will never be null.

getPromptField

@Nullable
String getPromptField()

The field to look up the prompt from.

Returns:

getValueField

@Nullable
String getValueField()

The field to use as the value to be sent.

Returns:

getMinItems

@Nullable
Long getMinItems()

Returns the minimum number of items to be selected.

Returns:

null, 0 or a positive Long.

getMaxItems

@Nullable
Long getMaxItems()

Returns the maximum number of items to be selected.

Returns:

null or a positive Long.

getSelectedValue

@Nullable
Object getSelectedValue()