play.data

Class DynamicForm

java.lang.Object

play.data.Form<DynamicForm.Dynamic>

play.data.DynamicForm

public class DynamicForm
extends Form<DynamicForm.Dynamic>

A dynamic form. This form is backed by a simple HashMap<String,String>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicForm.Dynamic Simple data structure used by DynamicForm.

Nested classes/interfaces inherited from class play.data.Form

Form.Display, Form.Field

Constructor Summary

Constructors

Constructor and Description
DynamicForm(Map<String,String> data, List<ValidationError> errors, Optional<DynamicForm.Dynamic> value, MessagesApi messagesApi, Formatters formatters, javax.validation.Validator validator) Creates a new dynamic form.
DynamicForm(Map<String,String> data, Map<String,List<ValidationError>> errors, Optional<DynamicForm.Dynamic> value, MessagesApi messagesApi, Formatters formatters, javax.validation.Validator validator) Deprecated. Deprecated as of 2.6.0. Replace the parameter Map<String,List<ValidationError>> with a simple List<ValidationError>.
DynamicForm(MessagesApi messagesApi, Formatters formatters, javax.validation.Validator validator) Creates a new empty dynamic form.

Method Summary

Modifier and Type	Method and Description
DynamicForm	bind(Map<String,String> data, String... allowedFields) Binds data to this form - that is, handles form submission.
DynamicForm	bindFromRequest(Http.Request request, String... allowedFields) Binds request data to this form - that is, handles form submission.
DynamicForm	bindFromRequest(String... allowedFields) Binds request data to this form - that is, handles form submission.
Map<String,String>	data() Deprecated.
ValidationError	error(String key) Deprecated. Deprecated as of 2.6.0. Use getError(String) instead.
Form.Field	field(String key) Retrieves a field.
DynamicForm	fill(Map<String,Object> value) Fills the form with existing data.
String	get(String key) Gets the concrete value only if the submission was a success.
Optional<ValidationError>	getError(String key) Retrieve an error by key.
Map<String,String>	rawData()
void	reject(String key, String error) Deprecated. Deprecated as of 2.6.0. Use withError(String, String) instead.
void	reject(String key, String error, List<Object> args) Deprecated. Deprecated as of 2.6.0. Use withError(String, String, List) instead.
Optional<Object>	value(String key) Gets the concrete value
DynamicForm	withError(String key, String error)
DynamicForm	withError(String key, String error, List<Object> args)

Methods inherited from class play.data.Form

allErrors, apply, bind, bindFromRequest, blankInstance, discardErrors, discardingErrors, errors, errors, errorsAsJson, errorsAsJson, fill, get, getArgumentsForConstraint, getBackedType, getGlobalError, getMessageForConstraintViolation, globalError, globalErrors, hasErrors, hasGlobalErrors, name, reject, reject, reject, requestData, toString, value, withError, withGlobalError, withGlobalError

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicForm

public DynamicForm(MessagesApi messagesApi,
                   Formatters formatters,
                   javax.validation.Validator validator)

Creates a new empty dynamic form.

Parameters:

messagesApi - the messagesApi component.

formatters - the formatters component.

validator - the validator component.

DynamicForm

public DynamicForm(Map<String,String> data,
                   List<ValidationError> errors,
                   Optional<DynamicForm.Dynamic> value,
                   MessagesApi messagesApi,
                   Formatters formatters,
                   javax.validation.Validator validator)

Creates a new dynamic form.

Parameters:

data - the current form data (used to display the form)

errors - the collection of errors associated with this form

value - optional concrete value if the form submission was successful

messagesApi - the messagesApi component.

formatters - the formatters component.

validator - the validator component.

DynamicForm

@Deprecated
public DynamicForm(Map<String,String> data,
                               Map<String,List<ValidationError>> errors,
                               Optional<DynamicForm.Dynamic> value,
                               MessagesApi messagesApi,
                               Formatters formatters,
                               javax.validation.Validator validator)

Deprecated. Deprecated as of 2.6.0. Replace the parameter Map<String,List<ValidationError>> with a simple List<ValidationError>.

Parameters:

data - the current form data (used to display the form)

errors - the collection of errors associated with this form

value - optional concrete value if the form submission was successful

messagesApi - the messagesApi component.

formatters - the formatters component.

validator - the validator component.

Method Detail

get

public String get(String key)

Gets the concrete value only if the submission was a success. If the form is invalid because of validation errors this method will return null. If you want to retrieve the value even when the form is invalid use value(String) instead.

Parameters:

key - the string key.

Returns:

the value, or null if there is no match.

value

public Optional<Object> value(String key)

Gets the concrete value

Parameters:

key - the string key.

Returns:

the value

data

@Deprecated
public Map<String,String> data()

Deprecated.

Overrides:

data in class Form<DynamicForm.Dynamic>

Returns:

the actual form data.

rawData

public Map<String,String> rawData()

Overrides:

rawData in class Form<DynamicForm.Dynamic>

Returns:

the actual form data as unmodifiable map.

fill

public DynamicForm fill(Map<String,Object> value)

Fills the form with existing data.

Parameters:

value - the map of values to fill in the form.

Returns:

the modified form.

bindFromRequest

public DynamicForm bindFromRequest(String... allowedFields)

Binds request data to this form - that is, handles form submission.

Overrides:

bindFromRequest in class Form<DynamicForm.Dynamic>

Parameters:

allowedFields - the fields that should be bound to the form, all fields if not specified.

Returns:

a copy of this form filled with the new data

bindFromRequest

public DynamicForm bindFromRequest(Http.Request request,
                                   String... allowedFields)

Binds request data to this form - that is, handles form submission.

Overrides:

bindFromRequest in class Form<DynamicForm.Dynamic>

Parameters:

request - the request to bind data from.

allowedFields - the fields that should be bound to the form, all fields if not specified.

Returns:

a copy of this form filled with the new data

bind

public DynamicForm bind(Map<String,String> data,
                        String... allowedFields)

Binds data to this form - that is, handles form submission.

Overrides:

bind in class Form<DynamicForm.Dynamic>

Parameters:

data - data to submit

allowedFields - the fields that should be bound to the form, all fields if not specified.

Returns:

a copy of this form filled with the new data

field

public Form.Field field(String key)

Retrieves a field.

Overrides:

field in class Form<DynamicForm.Dynamic>

Parameters:

key - field name

Returns:

the field - even if the field does not exist you get a field

error

@Deprecated
public ValidationError error(String key)

Deprecated. Deprecated as of 2.6.0. Use getError(String) instead.

Retrieve an error by key.

Overrides:

error in class Form<DynamicForm.Dynamic>

Parameters:

key - the field name associated with the error.

Returns:

an error by key, or null.

getError

public Optional<ValidationError> getError(String key)

Retrieve an error by key.

Overrides:

getError in class Form<DynamicForm.Dynamic>

Parameters:

key - the field name associated with the error.

Returns:

an error by key

reject

@Deprecated
public void reject(String key,
                               String error,
                               List<Object> args)

Deprecated. Deprecated as of 2.6.0. Use withError(String, String, List) instead.

Adds an error to this form.

Overrides:

reject in class Form<DynamicForm.Dynamic>

Parameters:

key - the error key

error - the error message

args - the error arguments

withError

public DynamicForm withError(String key,
                             String error,
                             List<Object> args)

Overrides:

withError in class Form<DynamicForm.Dynamic>

Parameters:

key - the error key

error - the error message

args - the error arguments

Returns:

a copy of this form with the given error added.

reject

@Deprecated
public void reject(String key,
                               String error)

Deprecated. Deprecated as of 2.6.0. Use withError(String, String) instead.

Adds an error to this form.

Overrides:

reject in class Form<DynamicForm.Dynamic>

Parameters:

key - the error key

error - the error message

withError

public DynamicForm withError(String key,
                             String error)

Overrides:

withError in class Form<DynamicForm.Dynamic>

Parameters:

key - the error key

error - the error message

Returns:

a copy of this form with the given error added.