io.mangoo.routing.bindings

Class Form

java.lang.Object

io.mangoo.routing.bindings.Form

All Implemented Interfaces:

MangooValidator

public class Form
extends Object
implements MangooValidator

Author:

svenkubiak

Constructor Summary

Constructors

Constructor and Description
Form(Validator validator)

Method Summary

Modifier and Type	Method and Description
void	addFile(File file)
void	addValue(String key, String value)
String	get(String key) Retrieves a form value corresponding to the name of the form element
Optional<Boolean>	getBoolean(String key) Retrieves an optional boolean value corresponding to the name of the form element 0 maps to false 1 maps to true "true" maps to true "false" maps to false
Optional<Double>	getDouble(String key) Retrieves an optional double value corresponding to the name of the form element
String	getError(String fieldName) Returns the errors message of specific field
Optional<File>	getFile() Retrieves a single file of the form.
List<File>	getFiles() Retrieves all attachment files of the form
Optional<Float>	getFloat(String key) Retrieves an optional float value corresponding to the name of the form element
Optional<Integer>	getInteger(String key) Retrieves an optional integer value corresponding to the name of the form element
Optional<String>	getString(String key) Retrieves an optional string value corresponding to the name of the form element
Map<String,String>	getValues() Retrieves all form submitted values where the key of the map corresponds to the name of the form element and the value is the value of the form element
boolean	hasError(String fieldName) Checks if a given field has a validation error
boolean	hasErrors() Checks if any field in the validation has an error
boolean	isSubmitted()
void	setSubmitted(boolean submitted)
Validator	validation() Returns the validator object for validation methods

Methods inherited from class java.lang.Object

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

Constructor Detail

Form

@Inject
public Form(Validator validator)

Method Detail

validation

public Validator validation()

Description copied from interface: MangooValidator

Returns the validator object for validation methods

Specified by:

validation in interface MangooValidator

Returns:

A Validator object

getError

public String getError(String fieldName)

Description copied from interface: MangooValidator

Returns the errors message of specific field

Specified by:

getError in interface MangooValidator

Parameters:

fieldName - The field to check

Returns:

The errors message or null if no error

hasError

public boolean hasError(String fieldName)

Checks if a given field has a validation error

Parameters:

fieldName - The field name to check

Returns:

True if field has error, false otherwise

hasErrors

public boolean hasErrors()

Checks if any field in the validation has an error

Returns:

True if at least one field has an error, false otherwise

get

public String get(String key)

Retrieves a form value corresponding to the name of the form element

Parameters:

key - The name of the form element

Returns:

The value of the form or null if not present

getString

public Optional<String> getString(String key)

Retrieves an optional string value corresponding to the name of the form element

Parameters:

key - The name of the form element

Returns:

Optional of String

getBoolean

public Optional<Boolean> getBoolean(String key)

Retrieves an optional boolean value corresponding to the name of the form element 0 maps to false 1 maps to true "true" maps to true "false" maps to false

Parameters:

key - The name of the form element

Returns:

Optional of Boolean

getInteger

public Optional<Integer> getInteger(String key)

Retrieves an optional integer value corresponding to the name of the form element

Parameters:

key - The name of the form element

Returns:

Optional of Integer

getDouble

public Optional<Double> getDouble(String key)

Retrieves an optional double value corresponding to the name of the form element

Parameters:

key - The name of the form element

Returns:

Optional of Double

getFloat

public Optional<Float> getFloat(String key)

Retrieves an optional float value corresponding to the name of the form element

Parameters:

key - The name of the form element

Returns:

Optional of Float

getFiles

public List<File> getFiles()

Retrieves all attachment files of the form

Returns:

List of files or an empty list

getFile

public Optional<File> getFile()

Retrieves a single file of the form. If the the form has multiple files, the first will be returned

Returns:

File or null if no file is present

getValues

public Map<String,String> getValues()

Retrieves all form submitted values where the key of the map corresponds to the name of the form element and the value is the value of the form element

Returns:

Map with Key-Value elements or empty map

isSubmitted

public boolean isSubmitted()

addFile

public void addFile(File file)

setSubmitted

public void setSubmitted(boolean submitted)

addValue

public void addValue(String key,
                     String value)