Modifier and Type	Class and Description
public static class	FormData.FileItem
public static interface	FormData.FormValue
pack-priv static class	FormData.FormValueImpl

Modifier and Type	Field and Description
private final int	maxValues
private int	valueCount
private final Map<String, Deque<FormData.FormValue>>	values

Access	Constructor and Description
public	FormData(final int maxValues)

Method Summary

Modifier and Type	Method and Description
public void	add(String name, byte[] value, String fileName, HeaderMap headers)
public void	add(String name, String value)
public void	add(String name, String value, final HeaderMap headers)
public void	add(String name, String value, String charset, final HeaderMap headers)
public void	add(String name, Path value, String fileName, final HeaderMap headers)
public void	add(String name, Path value, String fileName, final HeaderMap headers, boolean bigField, String charset)
public boolean	contains(String name)
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Deque<FormData.FormValue>	get(String name)
public FormData.FormValue	getFirst(String name)
public FormData.FormValue	getLast(String name)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Iterator<String>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public void	put(String name, String value, final HeaderMap headers)
public Deque<FormData.FormValue>	remove(String name)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

maxValues	back to summary
private final int maxValues

valueCount	back to summary
private int valueCount

values	back to summary
private final Map<String, Deque<FormData.FormValue>> values

Constructor Detail

FormData	back to summary
public FormData(final int maxValues)

Method Detail

add	back to summary
public void add(String name, byte[] value, String fileName, HeaderMap headers)

add	back to summary
public void add(String name, String value)

add	back to summary
public void add(String name, String value, final HeaderMap headers)

add	back to summary
public void add(String name, String value, String charset, final HeaderMap headers)

add	back to summary
public void add(String name, Path value, String fileName, final HeaderMap headers)

add	back to summary
public void add(String name, Path value, String fileName, final HeaderMap headers, boolean bigField, String charset)

contains	back to summary
public boolean contains(String name)

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

get	back to summary
public Deque<FormData.FormValue> get(String name)

getFirst	back to summary
public FormData.FormValue getFirst(String name)

getLast	back to summary
public FormData.FormValue getLast(String name)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

iterator back to summary

iterator	back to summary
public Iterator<String> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<String> an Iterator.

public Iterator<String> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<String>: an Iterator.

put	back to summary
public void put(String name, String value, final HeaderMap headers)

remove	back to summary
public Deque<FormData.FormValue> remove(String name)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

io.undertow.server.handlers.form back to summary

public Class FormData.FileItem

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.handlers.form.FormData.FileItem

Field Summary

Modifier and Type	Field and Description
private final byte[]	content
private final Path	file

Constructor Summary

Access	Constructor and Description
public	FileItem(Path file)
public	FileItem(byte[] content)

Method Summary

Modifier and Type	Method and Description
public void	delete()
public Path	getFile()
public long	getFileSize()
public InputStream	getInputStream()
public boolean	isInMemory()
public void	write(Path target)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

content	back to summary
private final byte[] content

file	back to summary
private final Path file

Constructor Detail

FileItem	back to summary
public FileItem(Path file)

FileItem	back to summary
public FileItem(byte[] content)

Method Detail

delete	back to summary
public void delete() throws IOException

getFile	back to summary
public Path getFile()

getFileSize	back to summary
public long getFileSize() throws IOException

getInputStream	back to summary
public InputStream getInputStream() throws IOException

isInMemory	back to summary
public boolean isInMemory()

write	back to summary
public void write(Path target) throws IOException

io.undertow.server.handlers.form back to summary

public Interface FormData.FormValue

Known Direct Implementers: io.undertow.server.handlers.form.FormData.FormValueImpl

Method Summary

Modifier and Type	Method and Description
public String	Returns: The charset of the simple string value getCharset()
public File	getFile() Deprecated
public FormData.FileItem	getFileItem()
public String	Returns: The filename specified in the disposition header. getFileName()
public HeaderMap	Returns: The headers that were present in the multipart request, or null if this was not a multipart request getHeaders()
public Path	Returns: The temp file that the file data was saved to getPath() Deprecated
public String	Returns: the simple string value. getValue()
public boolean	Returns: true if size of the FormValue comes from a multipart request exceeds the fieldSizeThreshold of `MultiPartParserDefinition` without filename specified. A big field is stored in disk, it is a file based FileItem. getValue() returns getCharset() decoded string from the file if it is true. isBigField()
public boolean	isFile() Deprecated Returns true if this is a file and not a simple string
public boolean	isFileItem()

Method Detail

getCharset	back to summary
public String getCharset() Returns:String The charset of the simple string value

getFile	back to summary
public File getFile() Deprecated Annotations @Deprecated

getFileItem	back to summary
public FormData.FileItem getFileItem()

getFileName	back to summary
public String getFileName() Returns:String The filename specified in the disposition header.

getHeaders	back to summary
public HeaderMap getHeaders() Returns:HeaderMap The headers that were present in the multipart request, or null if this was not a multipart request

getPath	back to summary
public Path getPath() Deprecated Returns:Path The temp file that the file data was saved to Annotations @Deprecated Exceptions IllegalStateException: if this is not a file

getValue	back to summary
public String getValue() Returns:String the simple string value. Exceptions IllegalStateException: If this is not a simple string value

isBigField	back to summary
public boolean isBigField() Returns:boolean true if size of the FormValue comes from a multipart request exceeds the fieldSizeThreshold of `MultiPartParserDefinition` without filename specified. A big field is stored in disk, it is a file based FileItem. getValue() returns getCharset() decoded string from the file if it is true.

isFile	back to summary
public boolean isFile() Deprecated Returns true if this is a file and not a simple string Annotations @Deprecated

isFile

back to summary

public boolean isFile()

Deprecated

Returns true if this is a file and not a simple string

Annotations

@Deprecated

isFileItem	back to summary
public boolean isFileItem()

io.undertow.server.handlers.form back to summary

pack-priv Class FormData.FormValueImpl

Class Inheritance

extends Object
implements FormValue

java.lang.Object
io.undertow.server.handlers.form.FormData.FormValueImpl

All Implemented Interfaces

io.undertow.server.handlers.form.FormData.FormValue

Field Summary

Modifier and Type	Field and Description
private final boolean	bigField
private final String	charset
private final FormData.FileItem	fileItem
private final String	fileName
private final HeaderMap	headers
private final String	value

Constructor Summary

Access	Constructor and Description
pack-priv	FormValueImpl(String value, HeaderMap headers)
pack-priv	FormValueImpl(String value, String charset, HeaderMap headers)
pack-priv	FormValueImpl(Path file, final String fileName, HeaderMap headers, boolean bigField, String charset)
pack-priv	FormValueImpl(byte[] data, String fileName, HeaderMap headers)

Method Summary

Modifier and Type	Method and Description
public String	getCharset() Implements io.undertow.server.handlers.form.FormData.FormValue.getCharset.
public File	getFile() Implements io.undertow.server.handlers.form.FormData.FormValue.getFile.
public FormData.FileItem	getFileItem() Implements io.undertow.server.handlers.form.FormData.FormValue.getFileItem.
public String	getFileName() Implements io.undertow.server.handlers.form.FormData.FormValue.getFileName.
public HeaderMap	getHeaders() Implements io.undertow.server.handlers.form.FormData.FormValue.getHeaders.
public Path	getPath() Implements io.undertow.server.handlers.form.FormData.FormValue.getPath.
public String	getValue() Implements io.undertow.server.handlers.form.FormData.FormValue.getValue.
public boolean	isBigField() Implements io.undertow.server.handlers.form.FormData.FormValue.isBigField.
public boolean	isFile() Implements io.undertow.server.handlers.form.FormData.FormValue.isFile. Returns true if this is a file and not a simple string
public boolean	isFileItem() Implements io.undertow.server.handlers.form.FormData.FormValue.isFileItem.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bigField	back to summary
private final boolean bigField

charset	back to summary
private final String charset

fileItem	back to summary
private final FormData.FileItem fileItem

fileName	back to summary
private final String fileName

headers	back to summary
private final HeaderMap headers

value	back to summary
private final String value

Constructor Detail

FormValueImpl	back to summary
pack-priv FormValueImpl(String value, HeaderMap headers)

FormValueImpl	back to summary
pack-priv FormValueImpl(String value, String charset, HeaderMap headers)

FormValueImpl	back to summary
pack-priv FormValueImpl(Path file, final String fileName, HeaderMap headers, boolean bigField, String charset)

FormValueImpl	back to summary
pack-priv FormValueImpl(byte[] data, String fileName, HeaderMap headers)

Method Detail

getCharset

back to summary

public String getCharset()

Implements io.undertow.server.handlers.form.FormData.FormValue.getCharset.

Returns:String

Doc from io.undertow.server.handlers.form.FormData.FormValue.getCharset.

The charset of the simple string value

Annotations

@Override

getFile

back to summary

public File getFile()

Implements io.undertow.server.handlers.form.FormData.FormValue.getFile.

Annotations

@Override

getFileItem

back to summary

public FormData.FileItem getFileItem()

Implements io.undertow.server.handlers.form.FormData.FormValue.getFileItem.

Annotations

@Override

getFileName

back to summary

public String getFileName()

Implements io.undertow.server.handlers.form.FormData.FormValue.getFileName.

Returns:String

Doc from io.undertow.server.handlers.form.FormData.FormValue.getFileName.

The filename specified in the disposition header.

getHeaders

back to summary

public HeaderMap getHeaders()

Implements io.undertow.server.handlers.form.FormData.FormValue.getHeaders.

Returns:HeaderMap

Doc from io.undertow.server.handlers.form.FormData.FormValue.getHeaders.

The headers that were present in the multipart request, or null if this was not a multipart request

Annotations

@Override

getPath

back to summary

public Path getPath()

Implements io.undertow.server.handlers.form.FormData.FormValue.getPath.

Returns:Path

Doc from io.undertow.server.handlers.form.FormData.FormValue.getPath.

The temp file that the file data was saved to

Annotations

@Override

getValue

back to summary

public String getValue()

Implements io.undertow.server.handlers.form.FormData.FormValue.getValue.

Returns:String

Doc from io.undertow.server.handlers.form.FormData.FormValue.getValue.

the simple string value.

Annotations

@Override

isBigField back to summary

public boolean isBigField()

Implements io.undertow.server.handlers.form.FormData.FormValue.isBigField.

Returns:boolean

Doc from io.undertow.server.handlers.form.FormData.FormValue.isBigField.

true if size of the FormValue comes from a multipart request exceeds the fieldSizeThreshold of MultiPartParserDefinition without filename specified. A big field is stored in disk, it is a file based FileItem. getValue() returns getCharset() decoded string from the file if it is true.

isFile

back to summary

public boolean isFile()

Implements io.undertow.server.handlers.form.FormData.FormValue.isFile.

Doc from io.undertow.server.handlers.form.FormData.FormValue.isFile.

Returns true if this is a file and not a simple string

Annotations