Class QueryParser

java.lang.Object
org.simpleframework.util.parse.Parser
org.simpleframework.util.parse.MapParser<String>
org.simpleframework.http.parse.QueryParser
All Implemented Interfaces:
Map<String,String>, Query
public class QueryParser extends MapParser<String> implements Query
The ParameterParser is used to parse data encoded in the application/x-www-form-urlencoded MIME type. It is also used to parse a query string from a HTTP URL, see RFC 2616. The parsed parameters are available through the various methods of the org.simpleframework.http.net.Query interface. The syntax of the parsed parameters is described below in BNF. 

   params  = *(pair [ "&" params])
   pair    = name "=" value
   name    = *(text | escaped)
   value   = *(text | escaped)
   escaped = % HEX HEX
This will consume all data found as a name or value, if the data is a "+" character then it is replaced with a space character. This regards only "=", "&", and "%" as having special values. The "=" character delimits the name from the value and the "&" delimits the name value pair. The "%" character represents the start of an escaped sequence, which consists of two hex digits. All escaped sequences are converted to its character value.
Author:
Niall Gallagher

  • Constructor Details

    • QueryParser

      public QueryParser()
      Constructor for the ParameterParser. This creates an instance that can be use to parse HTML form data and URL query strings encoded as application/x-www-form-urlencoded. The parsed parameters are made available through the interface org.simpleframework.util.net.Query.

    • QueryParser

      public QueryParser(String text)
      Constructor for the ParameterParser. This creates an instance that can be use to parse HTML form data and URL query strings encoded as application/x-www-form-urlencoded. The parsed parameters are made available through the interface org.simpleframework.util.net.Query.
      Parameters:
      text - this is the text to parse for the parameters

  • Method Details

    • getInteger

      public int getInteger(Object name)
      This extracts an integer parameter for the named value. If the named parameter does not exist this will return a zero value. If however the parameter exists but is not in the format of a decimal integer value then this will throw an exception.
      Specified by:
      getInteger in interface Query
      Parameters:
      name - the name of the parameter value to retrieve
      Returns:
      this returns the named parameter value as an integer

    • getFloat

      public float getFloat(Object name)
      This extracts a float parameter for the named value. If the named parameter does not exist this will return a zero value. If however the parameter exists but is not in the format of a floating point number then this will throw an exception.
      Specified by:
      getFloat in interface Query
      Parameters:
      name - the name of the parameter value to retrieve
      Returns:
      this returns the named parameter value as a float

    • getBoolean

      public boolean getBoolean(Object name)
      This extracts a boolean parameter for the named value. If the named parameter does not exist this will return false otherwise the value is evaluated. If it is either true or false then those boolean values are returned.
      Specified by:
      getBoolean in interface Query
      Parameters:
      name - the name of the parameter value to retrieve
      Returns:
      this returns the named parameter value as an float

    • init

      protected void init()
      This initializes the parser so that it can be used several times. This clears any previous parameters extracted. This ensures that when the next parse(String) is invoked the status of the Query is empty.
      Specified by:
      init in class Parser

    • parse

      protected void parse()
      This performs the actual parsing of the parameter text. The parameters parsed from this are taken as "name=value" pairs. Multiple pairs within the text are separated by an "&". This will parse and insert all parameters into a hashtable.
      Specified by:
      parse in class Parser

    • toString

      public String toString(Set set)
      This toString method is used to compose an string in the application/x-www-form-urlencoded MIME type. This will encode the tokens specified in the Set. Each name=value pair acquired is converted into a UTF-8 escape sequence so that the parameters can be sent in the IS0-8859-1 format required via the HTTP/1.1 specification RFC 2616.
      Parameters:
      set - this is the set of parameters to be encoded
      Returns:
      returns a HTTP parameter encoding for the pairs

    • toString

      public String toString()
      This toString method is used to compose an string in the application/x-www-form-urlencoded MIME type. This will iterate over all tokens that have been added to this object, either during parsing, or during use of the instance. Each name=value pair acquired is converted into a UTF-8 escape sequence so that the parameters can be sent in the IS0-8859-1 format required via the HTTP/1.1 specification RFC 2616.
      Specified by:
      toString in interface Query
      Overrides:
      toString in class Object
      Returns:
      returns a HTTP parameter encoding for the pairs