Package io.mangoo.routing.bindings

Class Form

java.lang.Object

io.mangoo.routing.bindings.Validator

io.mangoo.routing.bindings.Form

All Implemented Interfaces:

Serializable

public class Form
extends Validator

Author:

svenkubiak

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Form()

Method Summary

Modifier and Type	Method	Description
void	addFile(InputStream inputStream)	Adds a file as an InputStream to the form
void	addValueList(String key, String value)	Adds an item to the value list
void	discard()	Discards the complete form
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
Optional<InputStream>	getFile()	Retrieves a single file of the form.
List<InputStream>	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
String	getValue(String key)	Retrieves a string value corresponding to the name of the form element
List<String>	getValueList(String key)	Retrieves the value list for a given key
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	isKept()	Checks if the form values are to put in the flash scope
boolean	isSubmitted()
void	keep()	Adds the form values to the flash scope
void	setSubmitted(boolean submitted)
<T> T	toObject(Class<?> clazz)	Converts the current form into a given object class

Methods inherited from class io.mangoo.routing.bindings.Validator

addValue, expectDomainName, expectDomainName, expectEmail, expectEmail, expectExactMatch, expectExactMatch, expectFalse, expectFalse, expectIpv4, expectIpv4, expectIpv6, expectIpv6, expectMatch, expectMatch, expectMatch, expectMatch, expectMaxLength, expectMaxLength, expectMaxValue, expectMaxValue, expectMinLength, expectMinLength, expectMinValue, expectMinValue, expectNotNull, expectNotNull, expectNull, expectNull, expectNumeric, expectNumeric, expectRangeLength, expectRangeLength, expectRangeValue, expectRangeValue, expectRegex, expectRegex, expectTrue, expectTrue, expectUrl, expectUrl, expectValue, expectValue, get, getError, getErrors, hasError, hasErrors, invalidate, isValid, setValues

Methods inherited from class java.lang.Object

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

Constructor Details

Form

public Form()

Method Details

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

getValue

public String getValue(String key)

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

Parameters:

key - The name of the form element

Returns:

String with the value of the form element or an empty value if blank

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<InputStream> getFiles()

Retrieves all attachment files of the form

Returns:

List of files or an empty list

getFile

public Optional<InputStream> getFile()

Retrieves a single file of the form. If 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

addFile

public void addFile(InputStream inputStream)

Adds a file as an InputStream to the form

Parameters:

inputStream - The InputStream to add

keep

public void keep()

Adds the form values to the flash scope

addValueList

public void addValueList(String key,
 String value)

Adds an item to the value list

Parameters:

key - The name of the form element

value - The value to store

getValueList

public List<String> getValueList(String key)

Retrieves the value list for a given key

Parameters:

key - The name of the form element

Returns:

A value list with elements

isKept

public boolean isKept()

Checks if the form values are to put in the flash scope

Returns:

True if form values should be put into flash scope, false otherwise

discard

public void discard()

Discards the complete form

toObject

public <T> T toObject(Class<?> clazz)

Converts the current form into a given object class

Type Parameters:

T - Ignored

Parameters:

clazz - The class to convert to

Returns:

The converted object or null if conversion fails

isSubmitted

public boolean isSubmitted()

setSubmitted

public void setSubmitted(boolean submitted)