com.noelios.restlet.util
Class FormUtils

java.lang.Object
  extended by com.noelios.restlet.util.FormUtils

public class FormUtils
extends java.lang.Object

Representation of a Web form containing submitted parameters.

Author:
Jerome Louvel

Constructor Summary
FormUtils()
           
 
Method Summary
static Parameter create(java.lang.CharSequence name, java.lang.CharSequence value, boolean decode, CharacterSet characterSet)
          Creates a parameter.
static Parameter getFirstParameter(Representation post, java.lang.String name)
          Reads the first parameter with the given name.
static Parameter getFirstParameter(java.lang.String query, java.lang.String name, CharacterSet characterSet, char separator)
          Reads the first parameter with the given name.
static java.lang.Object getParameter(Representation form, java.lang.String name)
          Reads the parameters with the given name.
If multiple values are found, a list is returned created.
static java.lang.Object getParameter(java.lang.String query, java.lang.String name, CharacterSet characterSet, char separator)
          Reads the parameters with the given name.
If multiple values are found, a list is returned created.
static void getParameters(Representation post, java.util.Map<java.lang.String,java.lang.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(java.lang.String parametersString, java.util.Map<java.lang.String,java.lang.Object> parameters, CharacterSet characterSet, char separator)
          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 parse(Form form, Representation post)
          Parses a post into a given form.
static void parse(Form form, java.lang.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
 

Constructor Detail

FormUtils

public FormUtils()
Method Detail

create

public static Parameter create(java.lang.CharSequence name,
                               java.lang.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,
                                          java.lang.String name)
                                   throws java.io.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:
java.io.IOException

getFirstParameter

public static Parameter getFirstParameter(java.lang.String query,
                                          java.lang.String name,
                                          CharacterSet characterSet,
                                          char separator)
                                   throws java.io.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.
Returns:
The parameter.
Throws:
java.io.IOException

getParameter

public static java.lang.Object getParameter(Representation form,
                                            java.lang.String name)
                                     throws java.io.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:
java.io.IOException - If the parameters could not be read.

getParameter

public static java.lang.Object getParameter(java.lang.String query,
                                            java.lang.String name,
                                            CharacterSet characterSet,
                                            char separator)
                                     throws java.io.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.
Returns:
The parameter value or list of values.
Throws:
java.io.IOException - If the parameters could not be read.

getParameters

public static void getParameters(Representation post,
                                 java.util.Map<java.lang.String,java.lang.Object> parameters)
                          throws java.io.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:
java.io.IOException - If the parameters could not be read.

getParameters

public static void getParameters(java.lang.String parametersString,
                                 java.util.Map<java.lang.String,java.lang.Object> parameters,
                                 CharacterSet characterSet,
                                 char separator)
                          throws java.io.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.
Throws:
java.io.IOException - If the parameters could not be read.

parse

public static void parse(Form form,
                         Representation post)
Parses a post into a given form.

Parameters:
form - The target form.
post - The posted form.

parse

public static void parse(Form form,
                         java.lang.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 query parameters should be decoded using the given character set.
separator - The separator character to append between parameters.


Copyright © 2005-2008 Noelios Technologies.