play.data

Class Form.Field

java.lang.Object

play.data.Form.Field

Enclosing class:

Form<T>

public static class Form.Field
extends java.lang.Object

A form field.

Constructor Summary

Constructors

Constructor and Description
Field(Form<?> form, java.lang.String name, java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>> constraints, F.Tuple<java.lang.String,java.util.List<java.lang.Object>> format, java.util.List<ValidationError> errors, Http.MultipartFormData.FilePart<?> file)
Field(Form<?> form, java.lang.String name, java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>> constraints, F.Tuple<java.lang.String,java.util.List<java.lang.Object>> format, java.util.List<ValidationError> errors, java.lang.String value) Creates a form field.
Field(Form<?> form, java.lang.String name, java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>> constraints, F.Tuple<java.lang.String,java.util.List<java.lang.Object>> format, java.util.List<ValidationError> errors, java.lang.String value, Http.MultipartFormData.FilePart<?> file)

Method Summary

Modifier and Type	Method and Description
java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>>	constraints() Returns all the constraints associated with this field.
java.util.List<ValidationError>	errors() Returns all the errors associated with this field.
<A> java.util.Optional<Http.MultipartFormData.FilePart<A>>	file()
F.Tuple<java.lang.String,java.util.List<java.lang.Object>>	format() Returns the expected format for this field.
java.util.Optional<java.lang.String>	getName() Deprecated. Deprecated as of 2.7.0. Method has been renamed to name().
java.util.Optional<java.lang.String>	getValue() Deprecated. Deprecated as of 2.7.0. Method has been renamed to value().
java.util.List<java.lang.Integer>	indexes()
java.util.Optional<java.lang.String>	name()
Form.Field	sub(java.lang.String key) Get a sub-field, with a key relative to the current field.
Form.Field	sub(java.lang.String key, Lang lang) Get a sub-field, with a key relative to the current field.
java.lang.String	toString()
java.util.Optional<java.lang.String>	value()

Methods inherited from class java.lang.Object

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

Constructor Detail

Field

public Field(Form<?> form,
             java.lang.String name,
             java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>> constraints,
             F.Tuple<java.lang.String,java.util.List<java.lang.Object>> format,
             java.util.List<ValidationError> errors,
             java.lang.String value)

Creates a form field.

Parameters:

form - the form.

name - the field name

constraints - the constraints associated with the field

format - the format expected for this field

errors - the errors associated with this field

value - the field value, if any

Field

public Field(Form<?> form,
             java.lang.String name,
             java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>> constraints,
             F.Tuple<java.lang.String,java.util.List<java.lang.Object>> format,
             java.util.List<ValidationError> errors,
             Http.MultipartFormData.FilePart<?> file)

Field

public Field(Form<?> form,
             java.lang.String name,
             java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>> constraints,
             F.Tuple<java.lang.String,java.util.List<java.lang.Object>> format,
             java.util.List<ValidationError> errors,
             java.lang.String value,
             Http.MultipartFormData.FilePart<?> file)

Method Detail

getName

@Deprecated
public java.util.Optional<java.lang.String> getName()

Deprecated. Deprecated as of 2.7.0. Method has been renamed to name().

Returns:

The field name.

name

public java.util.Optional<java.lang.String> name()

Returns:

The field name.

getValue

@Deprecated
public java.util.Optional<java.lang.String> getValue()

Deprecated. Deprecated as of 2.7.0. Method has been renamed to value().

Returns:

The field value, if defined.

value

public java.util.Optional<java.lang.String> value()

Returns:

The field value, if defined.

file

public <A> java.util.Optional<Http.MultipartFormData.FilePart<A>> file()

Returns:

The file, if defined.

errors

public java.util.List<ValidationError> errors()

Returns all the errors associated with this field.

Returns:

The errors associated with this field.

constraints

public java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>> constraints()

Returns all the constraints associated with this field.

Returns:

The constraints associated with this field.

format

public F.Tuple<java.lang.String,java.util.List<java.lang.Object>> format()

Returns the expected format for this field.

Returns:

The expected format for this field.

indexes

public java.util.List<java.lang.Integer> indexes()

Returns:

the indexes available for this field (for repeated fields and List)

sub

public Form.Field sub(java.lang.String key)

Get a sub-field, with a key relative to the current field.

Parameters:

key - the key

Returns:

the subfield corresponding to the key.

sub

public Form.Field sub(java.lang.String key,
                      Lang lang)

Get a sub-field, with a key relative to the current field.

Parameters:

key - the key

lang - used for formatting

Returns:

the subfield corresponding to the key.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object