org.springframework.hateoas.mediatype.hal.forms

Class HalFormsOptions.AbstractHalFormsOptions<T extends HalFormsOptions.AbstractHalFormsOptions<T>>

java.lang.Object

org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions.AbstractHalFormsOptions<T>

All Implemented Interfaces:

HalFormsOptions

Direct Known Subclasses:

HalFormsOptions.Inline, HalFormsOptions.Remote

Enclosing interface:

HalFormsOptions

public abstract static class HalFormsOptions.AbstractHalFormsOptions<T extends HalFormsOptions.AbstractHalFormsOptions<T>>
extends Object
implements HalFormsOptions

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.hateoas.mediatype.hal.forms.HalFormsOptions

HalFormsOptions.AbstractHalFormsOptions<T extends HalFormsOptions.AbstractHalFormsOptions<T>>, HalFormsOptions.Inline, HalFormsOptions.Remote

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHalFormsOptions(String promptRef, String valueRef, Long minItems, Long maxItems, Object selectedValue)

Method Summary

Modifier and Type	Method and 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.
protected abstract T	with(String promptRef, String valueRef, Long minItems, Long maxItems, Object selectedValue) Create a new concrete HalFormsOptions.AbstractHalFormsOptions
T	withMaxItems(Long maxItems) Configures the maximum number of items to be selected.
T	withMinItems(Long minItems) Configures the minimum number of items to be selected.
T	withPromptField(String promptField) Configures the given field to be used as prompt field.
T	withSelectedValue(Object value) Configured the value to be initially selected
T	withValueField(String valueField) Configures the given field to be used as value field.

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.mediatype.hal.forms.HalFormsOptions

inline, inline, remote, remote

Constructor Detail

AbstractHalFormsOptions

protected AbstractHalFormsOptions(@Nullable
                                  String promptRef,
                                  @Nullable
                                  String valueRef,
                                  @Nullable
                                  Long minItems,
                                  @Nullable
                                  Long maxItems,
                                  @Nullable
                                  Object selectedValue)

Method Detail

getPromptField

@Nullable
public String getPromptField()

Description copied from interface: HalFormsOptions

The field to look up the prompt from.

Specified by:

getPromptField in interface HalFormsOptions

Returns:

getValueField

@Nullable
public String getValueField()

Description copied from interface: HalFormsOptions

The field to use as the value to be sent.

Specified by:

getValueField in interface HalFormsOptions

Returns:

getMinItems

@Nullable
public Long getMinItems()

Description copied from interface: HalFormsOptions

Returns the minimum number of items to be selected.

Specified by:

getMinItems in interface HalFormsOptions

Returns:

null, 0 or a positive Long.

getMaxItems

@Nullable
public Long getMaxItems()

Description copied from interface: HalFormsOptions

Returns the maximum number of items to be selected.

Specified by:

getMaxItems in interface HalFormsOptions

Returns:

null or a positive Long.

getSelectedValue

@Nullable
public Object getSelectedValue()

Specified by:

getSelectedValue in interface HalFormsOptions

withPromptField

public T withPromptField(String promptField)

Configures the given field to be used as prompt field.

Parameters:

promptField - must either be null or actually have text.

Returns:

withValueField

public T withValueField(String valueField)

Configures the given field to be used as value field.

Parameters:

valueField - must either be null or actually have text.

Returns:

withMinItems

public T withMinItems(Long minItems)

Configures the minimum number of items to be selected.

Parameters:

minItems - must be null or greater than or equal to zero.

Returns:

withMaxItems

public T withMaxItems(@Nullable
                      Long maxItems)

Configures the maximum number of items to be selected.

Parameters:

maxItems - must be null or greater than zero.

Returns:

withSelectedValue

public T withSelectedValue(@Nullable
                           Object value)

Configured the value to be initially selected

Parameters:

value -

Returns:

with

protected abstract T with(@Nullable
                          String promptRef,
                          @Nullable
                          String valueRef,
                          @Nullable
                          Long minItems,
                          @Nullable
                          Long maxItems,
                          @Nullable
                          Object selectedValue)

Create a new concrete HalFormsOptions.AbstractHalFormsOptions

Parameters:

promptRef -

valueRef -

minItems -

maxItems -

Returns: