Restlet Framework 2.2 Snapshot
OSGi Environments

org.restlet.data
Class Form

java.lang.Object
  extended by org.restlet.util.WrapperList<T>
      extended by org.restlet.util.Series<Parameter>
          extended by org.restlet.data.Form
All Implemented Interfaces:
Iterable<Parameter>, Collection<Parameter>, List<Parameter>

public class Form
extends Series<Parameter>

Form which is a specialized modifiable list of parameters.

Author:
Jerome Louvel
See Also:
User Guide - Getting parameter values

Field Summary
 
Fields inherited from class org.restlet.util.Series
EMPTY_VALUE
 
Constructor Summary
Form()
          Empty constructor.
Form(int initialCapacity)
          Constructor.
Form(List<Parameter> delegate)
          Constructor.
Form(Representation webForm)
          Constructor.
Form(Representation webForm, boolean decode)
          Constructor.
Form(String queryString)
          Constructor.
Form(String queryString, boolean decode)
          Constructor.
Form(String parametersString, char separator)
          Constructor.
Form(String queryString, CharacterSet characterSet)
          Constructor.
Form(String queryString, CharacterSet characterSet, boolean decode)
          Constructor.
Form(String parametersString, CharacterSet characterSet, char separator)
          Constructor.
Form(String parametersString, CharacterSet characterSet, char separator, boolean decode)
          Constructor.
Form(String parametersString, char separator, boolean decode)
          Constructor.
 
Method Summary
 Parameter createEntry(String name, String value)
          Creates a new entry.
 String encode()
          Encodes the form using the standard URI encoding mechanism and the UTF-8 character set.
 String encode(CharacterSet characterSet)
          URL encodes the form.
 String encode(CharacterSet characterSet, char separator)
          URL encodes the form.
 String getMatrixString()
          Formats the form as a matrix path string.
 String getMatrixString(CharacterSet characterSet)
          Formats the form as a query string.
 String getQueryString()
          Formats the form as a query string.
 String getQueryString(CharacterSet characterSet)
          Formats the form as a query string.
 Representation getWebRepresentation()
          Returns the form as a Web representation (MediaType.APPLICATION_WWW_FORM).
 Representation getWebRepresentation(CharacterSet characterSet)
          Returns the form as a Web representation (MediaType.APPLICATION_WWW_FORM).
 
Methods inherited from class org.restlet.util.Series
add, copyTo, getFirst, getFirst, getFirstValue, getFirstValue, getFirstValue, getFirstValue, getNames, getValues, getValues, getValuesArray, getValuesArray, getValuesArray, getValuesArray, getValuesMap, removeAll, removeAll, removeFirst, removeFirst, set, set, subList, subList, subList, unmodifiableSeries
 
Methods inherited from class org.restlet.util.WrapperList
add, add, addAll, addAll, clear, contains, containsAll, equals, get, getDelegate, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Form

public Form()
Empty constructor.


Form

public Form(int initialCapacity)
Constructor.

Parameters:
initialCapacity - The initial list capacity.

Form

public Form(List<Parameter> delegate)
Constructor.

Parameters:
delegate - The delegate list.

Form

public Form(Representation webForm)
Constructor.

Parameters:
webForm - The URL encoded Web form.
Throws:
IOException

Form

public Form(Representation webForm,
            boolean decode)
Constructor.

Parameters:
webForm - The URL encoded Web form.
Throws:
IOException

Form

public Form(String queryString)
Constructor. Uses UTF-8 as the character set for encoding non-ASCII characters.

Parameters:
queryString - The Web form parameters as a string.
Throws:
IOException

Form

public Form(String queryString,
            boolean decode)
Constructor. Uses UTF-8 as the character set for encoding non-ASCII characters.

Parameters:
queryString - The Web form parameters as a string.
decode - Indicates if the names and values should be automatically decoded.
Throws:
IOException

Form

public Form(String parametersString,
            char separator)
Constructor. Uses UTF-8 as the character set for encoding non-ASCII characters.

Parameters:
parametersString - The parameters string to parse.
separator - The separator character to append between parameters.
Throws:
IOException

Form

public Form(String parametersString,
            char separator,
            boolean decode)
Constructor. Uses UTF-8 as the character set for encoding non-ASCII characters.

Parameters:
parametersString - The parameters string to parse.
separator - The separator character to append between parameters.
decode - Indicates if the names and values should be automatically decoded.
Throws:
IOException

Form

public Form(String queryString,
            CharacterSet characterSet)
Constructor.

Parameters:
queryString - The Web form parameters as a string.
characterSet - The supported character encoding.
Throws:
IOException

Form

public Form(String queryString,
            CharacterSet characterSet,
            boolean decode)
Constructor.

Parameters:
queryString - The Web form parameters as a string.
characterSet - The supported character encoding.
decode - Indicates if the names and values should be automatically decoded.
Throws:
IOException

Form

public Form(String parametersString,
            CharacterSet characterSet,
            char separator)
Constructor.

Parameters:
parametersString - The parameters string to parse.
characterSet - The supported character encoding.
separator - The separator character to append between parameters.
Throws:
IOException

Form

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

Parameters:
parametersString - The parameters string to parse.
characterSet - The supported character encoding.
separator - The separator character to append between parameters.
decode - Indicates if the names and values should be automatically decoded.
Throws:
IOException
Method Detail

createEntry

public Parameter createEntry(String name,
                             String value)
Description copied from class: Series
Creates a new entry.

Overrides:
createEntry in class Series<Parameter>
Parameters:
name - The name of the entry.
value - The value of the entry.
Returns:
A new entry.

encode

public String encode()
              throws IOException
Encodes the form using the standard URI encoding mechanism and the UTF-8 character set.

Returns:
The encoded form.
Throws:
IOException

encode

public String encode(CharacterSet characterSet)
              throws IOException
URL encodes the form. The '&' character is used as a separator.

Parameters:
characterSet - The supported character encoding.
Returns:
The encoded form.
Throws:
IOException

encode

public String encode(CharacterSet characterSet,
                     char separator)
              throws IOException
URL encodes the form.

Parameters:
characterSet - The supported character encoding.
separator - The separator character to append between parameters.
Returns:
The encoded form.
Throws:
IOException

getMatrixString

public String getMatrixString()
Formats the form as a matrix path string. Uses UTF-8 as the character set for encoding non-ASCII characters.

Returns:
The form as a matrix string.
See Also:
Matrix URIs by Tim Berners Lee

getMatrixString

public String getMatrixString(CharacterSet characterSet)
Formats the form as a query string.

Parameters:
characterSet - The supported character encoding.
Returns:
The form as a matrix string.
See Also:
Matrix URIs by Tim Berners Lee

getQueryString

public String getQueryString()
Formats the form as a query string. Uses UTF-8 as the character set for encoding non-ASCII characters.

Returns:
The form as a query string.

getQueryString

public String getQueryString(CharacterSet characterSet)
Formats the form as a query string.

Parameters:
characterSet - The supported character encoding.
Returns:
The form as a query string.

getWebRepresentation

public Representation getWebRepresentation()
Returns the form as a Web representation (MediaType.APPLICATION_WWW_FORM). Uses UTF-8 as the character set for encoding non-ASCII characters.

Returns:
The form as a Web representation.

getWebRepresentation

public Representation getWebRepresentation(CharacterSet characterSet)
Returns the form as a Web representation (MediaType.APPLICATION_WWW_FORM).

Parameters:
characterSet - The supported character encoding.
Returns:
The form as a Web representation.

Restlet Framework 2.2 Snapshot
OSGi Environments

Copyright © 2005-2014 Restlet.