- java.lang.Object
-
- javax.ws.rs.core.Form
-
public class Form extends Object
Represents the the HTML form data request entity encoded using the"application/x-www-form-urlencoded"
content type.- Since:
- 2.0
- Author:
- Marek Potociar
-
-
Constructor Summary
Constructors Constructor and Description Form()
Create a new form data instance.Form(MultivaluedMap<String,String> store)
Create a new form data instance and register a custom underlying parameter store.Form(String parameterName, String parameterValue)
Create a new form data instance with a single parameter entry.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description MultivaluedMap<String,String>
asMap()
Returns multivalued map representation of the form.Form
param(String name, String value)
Adds a new value to the specified form parameter.
-
-
-
Constructor Detail
-
Form
public Form()
Create a new form data instance.The underlying form parameter store is configured to preserve the insertion order of the parameters. I.e. parameters can be iterated in the same order as they were inserted into the
Form
.
-
Form
public Form(String parameterName, String parameterValue)
Create a new form data instance with a single parameter entry.The underlying form parameter store is configured to preserve the insertion order of the parameters. I.e. parameters can be iterated in the same order as they were inserted into the
Form
.- Parameters:
parameterName
- form parameter name.parameterValue
- form parameter value.
-
Form
public Form(MultivaluedMap<String,String> store)
Create a new form data instance and register a custom underlying parameter store.This method is useful in situations when a custom parameter store is needed in order to change the default parameter iteration order, improve performance or facilitate other custom requirements placed on the parameter store.
- Parameters:
store
- form data store used by the created form instance.
-
-
Method Detail
-
param
public Form param(String name, String value)
Adds a new value to the specified form parameter.- Parameters:
name
- name of the parameter.value
- new parameter value to be added.- Returns:
- updated
Form
instance.
-
asMap
public MultivaluedMap<String,String> asMap()
Returns multivalued map representation of the form.- Returns:
- form represented as multivalued map.
- See Also:
MultivaluedMap
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/ws/rs/core/form.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.