simple.util.net
Interface Parameters

All Superinterfaces:
java.util.Map
All Known Implementing Classes:
ParameterParser

public interface Parameters
extends java.util.Map

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

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Method Summary
 boolean getBoolean(java.lang.Object name)
          This extracts a boolean parameter for the named value.
 float getFloat(java.lang.Object name)
          This extracts a float parameter for the named value.
 int getInteger(java.lang.Object name)
          This extracts an integer parameter for the named value.
 java.lang.String getParameter(java.lang.Object name)
          This extracts a value for the given name.
 java.util.Enumeration getParameterNames()
          This enumerates the names of every parameter.
 java.lang.String toString()
          This will return all parameters represented using the HTTP URL query format.
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

getParameterNames

java.util.Enumeration getParameterNames()
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.

Returns:
this returns an Enumeration of names

getParameter

java.lang.String getParameter(java.lang.Object name)
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
Returns:
this returns the first value for the given name

getInteger

int getInteger(java.lang.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 a NumberFormatException.

Parameters:
name - the name of the parameter value to retrieve
Returns:
this returns the parameter value as an integer
Throws:
java.lang.NumberFormatException - if the value is not valid

getFloat

float getFloat(java.lang.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 a NumberFormatException.

Parameters:
name - the name of the parameter value to retrieve
Returns:
this returns the parameter value as a float
Throws:
java.lang.NumberFormatException - if the value is not valid

getBoolean

boolean getBoolean(java.lang.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. 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
Returns:
this returns the parameter value as an float

toString

java.lang.String toString()
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.

Overrides:
toString in class java.lang.Object
Returns:
returns an empty string if the is no parameters