Package com.adobe.granite.ui.components

Class FormData

java.lang.Object

com.adobe.granite.ui.components.FormData

public class FormData
extends Object

FormData represents the values of the form.

The values are represented as a ValueMap. The FormData is set at request scope, where usually it is set by the form component and read by the field components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormData.NameNotFoundMode	The mode on how to handle the scenario when the FormData doesn't have an entry of a certain name.

Method Summary

Modifier and Type	Method	Description
static FormData	from(SlingHttpServletRequest request)	Returns the current FormData.
<T> T	get(String name, T fieldValue, Class<T> type)	Returns the value for the given name, converted to type T.
<T> T	get(String name, T fieldValue, T defaultValue)	Returns the value for the given name, converted to type T.
FormData.NameNotFoundMode	getMode()	Returns the mode of the FormData.
ValueMap	getValueMap()	Returns the values.
boolean	isSelected(String name, String value, boolean isFieldOptionSelected)	An overload of isSelected(String, String, boolean, boolean) where forceIgnoreFreshness parameter is false.
boolean	isSelected(String name, String value, boolean isFieldOptionSelected, boolean forceIgnoreFreshness)	Returns true if the given value of the field option is selected; false otherwise.
static FormData	pop(SlingHttpServletRequest request)	Pops the current FormData.
static FormData	push(SlingHttpServletRequest request, ValueMap values, FormData.NameNotFoundMode nameNotFoundMode)	Creates a new FormData representing the given values to the request scope.

Methods inherited from class java.lang.Object

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

Method Detail

push

@Nonnull
public static FormData push(@Nonnull
                            SlingHttpServletRequest request,
                            @Nonnull
                            ValueMap values,
                            @Nonnull
                            FormData.NameNotFoundMode nameNotFoundMode)

Creates a new FormData representing the given values to the request scope. FormData supports nesting. By calling this method, a new FormData is created and becomes the current context.

Parameters:

request - The request to store the values

values - The values of the FormData

nameNotFoundMode - The mode when the FormData doesn't have an entry of a certain name

Returns:

The new instance of FormData

pop

@Nonnull
public static FormData pop(@Nonnull
                           SlingHttpServletRequest request)
                    throws IllegalStateException

Pops the current FormData.

Parameters:

request - The request storing the values

Returns:

The current FormData

Throws:

IllegalStateException - When this method is called before push(SlingHttpServletRequest, ValueMap, NameNotFoundMode)

from

@CheckForNull
public static FormData from(@Nonnull
                            SlingHttpServletRequest request)

Returns the current FormData.

Parameters:

request - The request storing the values

Returns:

The current FormData or null if there is none

getValueMap

@Nonnull
public ValueMap getValueMap()

Returns the values.

Returns:

The values

getMode

@Nonnull
public FormData.NameNotFoundMode getMode()

Returns the mode of the FormData.

Returns:

The mode

get

@CheckForNull
public <T> T get(@Nonnull
                 String name,
                 @CheckForNull
                 T fieldValue,
                 @Nonnull
                 Class<T> type)

Returns the value for the given name, converted to type T.

In the NameNotFoundMode#CHECK_FRESHNESS mode, if the given name is not found and the FormData is fresh, then the given fieldValue is returned. Otherwise, null is returned.

In the NameNotFoundMode#IGNORE_FRESHNESS mode, if the given name is not found, then the given fieldValue is returned.

Type Parameters:

T - The type of the value

Parameters:

name - The name of the field

fieldValue - The value of the field

type - The class of the type

Returns:

The value converted to type T, or the given fieldValue, or null, depending on the conditions described above.

get

@Nonnull
public <T> T get(@Nonnull
                 String name,
                 @Nonnull
                 T fieldValue,
                 @Nonnull
                 T defaultValue)

Returns the value for the given name, converted to type T.

In the NameNotFoundMode#CHECK_FRESHNESS mode, if the given name is not found and the FormData is fresh, then the given fieldValue is returned. Otherwise, the given defaultValue is returned.

In the NameNotFoundMode#IGNORE_FRESHNESS mode, if the given name is not found, then the given fieldValue is returned.

Type Parameters:

T - The type of the value

Parameters:

name - The name of the field

fieldValue - The value of the field

defaultValue - The default value

Returns:

The value converted to type T, or the given fieldValue, or the given default value, depending on the conditions described above.

isSelected

public boolean isSelected(@Nonnull
                          String name,
                          @CheckForNull
                          String value,
                          boolean isFieldOptionSelected)

An overload of isSelected(String, String, boolean, boolean) where forceIgnoreFreshness parameter is false.

Parameters:

name - The name of the field

value - The value of the field option to compare against

isFieldOptionSelected - true if the field option is selected; false otherwise.

Returns:

Whether the given value is selected or not, or the given isFieldOptionSelected, depending on the conditions described above.

isSelected

public boolean isSelected(@Nonnull
                          String name,
                          @CheckForNull
                          String value,
                          boolean isFieldOptionSelected,
                          boolean forceIgnoreFreshness)

Returns true if the given value of the field option is selected; false otherwise.

In the NameNotFoundMode#CHECK_FRESHNESS mode, if the given name is not found and the FormData is fresh, then the given isFieldOptionSelected is returned, false otherwise.

In the NameNotFoundMode#IGNORE_FRESHNESS mode, if the given name is not found, then the given isFieldOptionSelected is returned.

Parameters:

name - The name of the field

value - The value of the field option to compare against

isFieldOptionSelected - true if the field option is selected; false otherwise.

forceIgnoreFreshness - true to force to be FormData.NameNotFoundMode.IGNORE_FRESHNESS; false otherwise.

Returns:

Whether the given value is selected or not, or the given isFieldOptionSelected, depending on the conditions described above.