| simple.util.net.Parameters
All known Subclasses: simple.util.parse.ParameterParser,
| Parameters | | public interface Parameters extends Map(Code) | | The Parameters object is used to represent HTTP
parameters. Parameters are acquired by name and can be either a
string, float, int, or boolean value. This ensures that data can
be conviniently extracted in the correct type. This follows the
parameter methods found in the Java Servlet API Specification.
The parameter values found in a parameter set can extracted via
farmiliar methods such as getParameter. However,
unlike the Java servlet API this wrapper for HTTP parameters is
modifiable, that is, parameters can be added and removed.
author:
Niall Gallagher |
| Method Summary | |
| 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 otherwize the value is evaluated. | | 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. | | 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. | | public String | getParameter(Object name)
This extracts a value for the given name. | | public Enumeration | getParameterNames()
This enumerates the names of every parameter. | | public String | toString()
This will return all parameters represented using the HTTP
URL query format. |
| getBoolean | | public boolean getBoolean(Object name)(Code) | | This extracts a boolean parameter for the named value.
If the named parameter does not exist this will return
false otherwize the value is evaluated. If it is either
true or false then those
boolean values are returned, otherwize it is false.
Parameters:
name - the name of the parameter value to retrieve this returns the parameter value as an float |
| getFloat | | public float getFloat(Object name)(Code) | | 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 a NumberFormatException.
Parameters:
name - the name of the parameter value to retrieve this returns the parameter value as a float
throws:
NumberFormatException - if the value is not valid |
| getInteger | | public int getInteger(Object name)(Code) | | 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 a NumberFormatException.
Parameters:
name - the name of the parameter value to retrieve this returns the parameter value as an integer
throws:
NumberFormatException - if the value is not valid |
| getParameter | | public String getParameter(Object name)(Code) | | This extracts a value for the given name. The name issued
to this method must be from the Enumeration
issued. If there is no parameter of this name this will
return a null value.
Parameters:
name - the name of the parameter value to retrieve this returns the first value for the given name |
| getParameterNames | | public Enumeration getParameterNames()(Code) | | This enumerates the names of every parameter. This enables
the parameter values to be extracted by providing the name
to the getParameter method. The resulting
Enumeration contains string objects.
this returns an Enumeration of names |
| toString | | public String toString()(Code) | | This will return all parameters represented using the HTTP
URL query format. The x-www-form-urlencoded
format is used to encode the attributes, see RFC 2616.
This will also encode any special characters that appear
within the name and value pairs as an escaped sequence.
If there are no parameters an empty string is returned.
returns an empty string if the is no parameters |
|
|