org.restlet.ext.html.internal

Class FormReader

java.lang.Object

org.restlet.ext.html.internal.FormReader

public class FormReader
extends Object

Form reader.

Author:

Jerome Louvel

Constructor Summary

Constructors

Constructor and Description
FormReader(Representation representation) Constructor. In case the representation does not define a character set, the UTF-8 character set is used.
FormReader(String queryString, char separator) Constructor.
FormReader(String queryString, CharacterSet characterSet, char separator) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addEntries(Series<FormData> entries) Adds the entries into a given series.
Series<FormData>	read() Reads all the entries.
void	readEntries(Map<String,Object> entries) Reads the entries whose name is a key in the given map.
Object	readEntry(String name) Reads the entries with the given name.
FormData	readFirstEntry(String name) Reads the first entry with the given name.
FormData	readNextEntry() Reads the next entry available or null.

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(String queryString,
                  char separator)

Constructor. Will leave the parsed data encoded.

Parameters:

queryString - The query string.

FormReader

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

Constructor.

Parameters:

queryString - The query string.

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

Method Detail

addEntries

public void addEntries(Series<FormData> entries)

Adds the entries into a given series.

Parameters:

entries - The target series of entries.

read

public Series<FormData> read()
                      throws IOException

Reads all the entries.

Returns:

The form read.

Throws:

IOException - If the entries could not be read.

readEntries

public void readEntries(Map<String,Object> entries)
                 throws IOException

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

Parameters:

entries - The entries map controlling the reading.

Throws:

IOException - If the entries could not be read.

readEntry

public Object readEntry(String name)
                 throws IOException

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

Parameters:

name - The entry name to match.

Returns:

The entry value or list of values.

Throws:

IOException - If the entry could not be read.

readFirstEntry

public FormData readFirstEntry(String name)
                        throws IOException

Reads the first entry with the given name.

Parameters:

name - The entry name to match.

Returns:

The entry value.

Throws:

IOException

readNextEntry

public FormData readNextEntry()
                       throws IOException

Reads the next entry available or null.

Returns:

The next entry available or null.

Throws:

IOException - If the next entry could not be read.