org.restlet.engine.util
Class FormReader

java.lang.Object
  org.restlet.engine.util.FormReader

public class FormReader
extends Object

Form reader.

Author:

Jerome Louvel

Constructor Summary

FormReader(Representation representation)
Constructor.
In case the representation does not define a character set, the UTF-8 character set is used.

FormReader(Representation representation, boolean decode)
Constructor.
In case the representation does not define a character set, the UTF-8 character set is used.

FormReader(String parametersString, char separator)
Constructor.

FormReader(String parametersString, CharacterSet characterSet, char separator)
Constructor.

FormReader(String parametersString, CharacterSet characterSet, char separator, boolean decode)
Constructor.

Method Summary

void	addParameters(Series<Parameter> parameters) Adds the parameters into a given series.
Form	read() Reads all the parameters.
Parameter	readFirstParameter(String name) Reads the first parameter with the given name.
Parameter	readNextParameter() Reads the next parameter available or null.
Object	readParameter(String name) Reads the parameters with the given name.
void	readParameters(Map<String,Object> parameters) Reads the parameters whose name is a key in the given map.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormReader

public FormReader(Representation representation)
           throws IOException

Constructor.
In case the representation does not define a character set, the UTF-8 character set is used.

Parameters:

representation - The web form content.

Throws:

IOException - if the stream of the representation could not be opened.

FormReader

public FormReader(Representation representation,
                  boolean decode)
           throws IOException

Constructor.
In case the representation does not define a character set, the UTF-8 character set is used.

Parameters:

representation - The web form content.

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

Throws:

IOException - if the stream of the representation could not be opened.

FormReader

public FormReader(String parametersString,
                  char separator)

Constructor. Will leave the parsed data encoded.

Parameters:

parametersString - The parameters string.

separator - The separator character used between parameters.

FormReader

public FormReader(String parametersString,
                  CharacterSet characterSet,
                  char separator)

Constructor.

Parameters:

parametersString - The parameters string.

characterSet - The supported character encoding. Set to null to leave the data encoded.

separator - The separator character used between parameters.

FormReader

public FormReader(String parametersString,
                  CharacterSet characterSet,
                  char separator,
                  boolean decode)

Constructor.

Parameters:

parametersString - The parameters string.

characterSet - The supported character encoding. Set to null to leave the data encoded.

separator - The separator character used between parameters.

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

Method Detail

addParameters

public void addParameters(Series<Parameter> parameters)

Adds the parameters into a given series.

Parameters:

parameters - The target parameter series.

read

public Form read()
          throws IOException

Reads all the parameters.

Returns:

The form read.

Throws:

IOException - If the parameters could not be read.

readFirstParameter

public Parameter readFirstParameter(String name)
                             throws IOException

Reads the first parameter with the given name.

Parameters:

name - The parameter name to match.

Returns:

The parameter value.

Throws:

IOException

readNextParameter

public Parameter readNextParameter()
                            throws IOException

Reads the next parameter available or null.

Returns:

The next parameter available or null.

Throws:

IOException - If the next parameter could not be read.

readParameter

public Object readParameter(String name)
                     throws IOException

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

Parameters:

name - The parameter name to match.

Returns:

The parameter value or list of values.

Throws:

IOException - If the parameters could not be read.

readParameters

public void readParameters(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:

parameters - The parameters map controlling the reading.

Throws:

IOException - If the parameters could not be read.