org.restlet.engine.util

Class FormUtils

java.lang.Object

org.restlet.engine.util.FormUtils

public class FormUtils
extends Object

Representation of a Web form containing submitted parameters.

Author:

Jerome Louvel

Method Summary

Modifier and Type	Method and Description
static Parameter	create(CharSequence name, CharSequence value, boolean decode, CharacterSet characterSet) Creates a parameter.
static Parameter	getFirstParameter(Representation post, String name) Reads the first parameter with the given name.
static Parameter	getFirstParameter(String query, String name, CharacterSet characterSet, char separator, boolean decode) Reads the first parameter with the given name.
static Object	getParameter(Representation form, String name) Reads the parameters with the given name. If multiple values are found, a list is returned created.
static Object	getParameter(String query, String name, CharacterSet characterSet, char separator, boolean decode) Reads the parameters with the given name. If multiple values are found, a list is returned created.
static void	getParameters(Representation post, Map<String,Object> parameters) Reads the parameters whose name is a key in the given map. If a matching parameter is found, its value is put in the map. If multiple values are found, a list is created and set in the map.
static void	getParameters(String parametersString, Map<String,Object> parameters, CharacterSet characterSet, char separator, boolean decode) Reads the parameters whose name is a key in the given map. If a matching parameter is found, its value is put in the map. If multiple values are found, a list is created and set in the map.
static boolean	isParameterFound(Parameter searchedParam, MediaType mediaRange) Indicates if the searched parameter is specified in the given media range.
static void	parse(Form form, Representation post, boolean decode) Parses a post into a given form.
static void	parse(Form form, String parametersString, CharacterSet characterSet, boolean decode, char separator) Parses a parameters string into a given form.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Parameter create(CharSequence name,
                               CharSequence value,
                               boolean decode,
                               CharacterSet characterSet)

Creates a parameter.

Parameters:

name - The parameter name buffer.

value - The parameter value buffer (can be null).

decode - If true, the name and values are decoded with the given CharacterSet, if false, than nothing is decoded.

characterSet - The supported character encoding.

Returns:

The created parameter.

getFirstParameter

public static Parameter getFirstParameter(Representation post,
                                          String name)
                                   throws IOException

Reads the first parameter with the given name.

Parameters:

post - The web form representation.

name - The parameter name to match.

Returns:

The parameter.

Throws:

IOException

getFirstParameter

public static Parameter getFirstParameter(String query,
                                          String name,
                                          CharacterSet characterSet,
                                          char separator,
                                          boolean decode)
                                   throws IOException

Reads the first parameter with the given name.

Parameters:

query - The query string.

name - The parameter name to match.

characterSet - The supported character encoding.

separator - The separator character to append between parameters.

decode - Indicates if the parameters should be decoded using the given character set.

Returns:

The parameter.

Throws:

IOException

getParameter

public static Object getParameter(Representation form,
                                  String name)
                           throws IOException

Reads the parameters with the given name.
If multiple values are found, a list is returned created.

Parameters:

form - The web form representation.

name - The parameter name to match.

Returns:

The parameter value or list of values.

Throws:

IOException - If the parameters could not be read.

getParameter

public static Object getParameter(String query,
                                  String name,
                                  CharacterSet characterSet,
                                  char separator,
                                  boolean decode)
                           throws IOException

Reads the parameters with the given name.
If multiple values are found, a list is returned created.

Parameters:

query - The query string.

name - The parameter name to match.

characterSet - The supported character encoding.

separator - The separator character to append between parameters.

decode - Indicates if the parameters should be decoded using the given character set. s * @return The parameter value or list of values.

Throws:

IOException - If the parameters could not be read.

getParameters

public static void getParameters(Representation post,
                                 Map<String,Object> parameters)
                          throws IOException

Reads the parameters whose name is a key in the given map.
If a matching parameter is found, its value is put in the map.
If multiple values are found, a list is created and set in the map.

Parameters:

post - The web form representation.

parameters - The parameters map controlling the reading.

Throws:

IOException - If the parameters could not be read.

getParameters

public static void getParameters(String parametersString,
                                 Map<String,Object> parameters,
                                 CharacterSet characterSet,
                                 char separator,
                                 boolean decode)
                          throws IOException

Reads the parameters whose name is a key in the given map.
If a matching parameter is found, its value is put in the map.
If multiple values are found, a list is created and set in the map.

Parameters:

parametersString - The query string.

parameters - The parameters map controlling the reading.

characterSet - The supported character encoding.

separator - The separator character to append between parameters.

decode - Indicates if the parameters should be decoded using the given character set.

Throws:

IOException - If the parameters could not be read.

isParameterFound

public static boolean isParameterFound(Parameter searchedParam,
                                       MediaType mediaRange)

Indicates if the searched parameter is specified in the given media range.

Parameters:

searchedParam - The searched parameter.

mediaRange - The media range to inspect.

Returns:

True if the searched parameter is specified in the given media range.

parse

public static void parse(Form form,
                         Representation post,
                         boolean decode)

Parses a post into a given form.

Parameters:

form - The target form.

post - The posted form.

decode - Indicates if the parameters should be decoded.

parse

public static void parse(Form form,
                         String parametersString,
                         CharacterSet characterSet,
                         boolean decode,
                         char separator)

Parses a parameters string into a given form.

Parameters:

form - The target form.

parametersString - The parameters string.

characterSet - The supported character encoding.

decode - Indicates if the parameters should be decoded using the given character set.

separator - The separator character to append between parameters.