javax.ws.rs.core

Class Form

java.lang.Object

javax.ws.rs.core.Form

public class Form
extends java.lang.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<java.lang.String,java.lang.String> store) Create a new form data instance and register the underlying parameter store.
Form(java.lang.String parameterName, java.lang.String parameterValue) Create a new form data instance with a single parameter entry.

Method Summary

Methods

Modifier and Type	Method and Description
MultivaluedMap<java.lang.String,java.lang.String>	asMap() Returns multivalued map representation of the form.
Form	param(java.lang.String name, java.lang.String value) Adds a new value to the specified form parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Form

public Form()

Create a new form data instance.

Form

public Form(java.lang.String parameterName,
    java.lang.String parameterValue)

Create a new form data instance with a single parameter entry.

Parameters:

parameterName - form parameter name.

parameterValue - form parameter value.

Form

public Form(MultivaluedMap<java.lang.String,java.lang.String> store)

Create a new form data instance and register the underlying parameter store.

Parameters:

store - form data store used by the created form instance.

Method Detail

param

public Form param(java.lang.String name,
         java.lang.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<java.lang.String,java.lang.String> asMap()

Returns multivalued map representation of the form.

Returns:

form represented as multivalued map.

See Also:

MultivaluedMap