play.data

Class Form.Field

java.lang.Object

play.data.Form.Field

Enclosing class:

Form<T>

public static class Form.Field
extends Object

A form field.

Constructor Summary

Constructors

Constructor and Description
Field(Form<?> form, String name, List<F.Tuple<String,List<Object>>> constraints, F.Tuple<String,List<Object>> format, List<ValidationError> errors, String value) Creates a form field.

Method Summary

Modifier and Type	Method and Description
List<F.Tuple<String,List<Object>>>	constraints() Returns all the constraints associated with this field.
List<ValidationError>	errors() Returns all the errors associated with this field.
F.Tuple<String,List<Object>>	format() Returns the expected format for this field.
Optional<String>	getName()
Optional<String>	getValue()
List<Integer>	indexes()
String	name() Deprecated. Deprecated as of 2.6.0. Use getName() instead.
Form.Field	sub(String key) Get a sub-field, with a key relative to the current field.
String	toString()
String	value() Deprecated. Deprecated as of 2.6.0. Use getValue() instead.
String	valueOr(String or) Deprecated. Deprecated as of 2.6.0. Use getValue() instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

Field

public Field(Form<?> form,
             String name,
             List<F.Tuple<String,List<Object>>> constraints,
             F.Tuple<String,List<Object>> format,
             List<ValidationError> errors,
             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

Method Detail

name

@Deprecated
public String name()

Deprecated. Deprecated as of 2.6.0. Use getName() instead.

Returns the field name.

Returns:

The field name.

getName

public Optional<String> getName()

Returns:

The field name.

value

@Deprecated
public String value()

Deprecated. Deprecated as of 2.6.0. Use getValue() instead.

Returns the field value, if defined.

Returns:

The field value, if defined.

valueOr

@Deprecated
public String valueOr(String or)

Deprecated. Deprecated as of 2.6.0. Use getValue() instead.

Parameters:

or - the value to return if value is null.

Returns:

The field value, if defined.

getValue

public Optional<String> getValue()

Returns:

The field value, if defined.

errors

public List<ValidationError> errors()

Returns all the errors associated with this field.

Returns:

The errors associated with this field.

constraints

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

Returns all the constraints associated with this field.

Returns:

The constraints associated with this field.

format

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

Returns the expected format for this field.

Returns:

The expected format for this field.

indexes

public List<Integer> indexes()

Returns:

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

sub

public Form.Field sub(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.

toString

public String toString()

Overrides:

toString in class Object