com.arsdigita.util.servlet
Class HttpParameterMap

java.lang.Object
  extended bycom.arsdigita.util.servlet.HttpParameterMap

public class HttpParameterMap
extends Object

Represents a set of HTTP form or query parameters.

Version:
$Id: //core-platform/dev/src/com/arsdigita/util/servlet/HttpParameterMap.java#3 $
Author:
Justin Ross <jross@redhat.com>

Field Summary
static String versionId
           
 
Constructor Summary
HttpParameterMap()
           
HttpParameterMap(javax.servlet.http.HttpServletRequest sreq)
           
HttpParameterMap(Map params)
           
 
Method Summary
 void clear()
           
 void clearParameter(String name)
           
 String getParameter(String name)
           
 Map getParameterMap()
           
 String[] getParameterValues(String name)
           
 String getQueryString()
           
static void register(HttpParameterListener listener)
           
 void runListeners(javax.servlet.http.HttpServletRequest sreq)
           
 void setParameter(String name, Object value)
          A convenience method that calls setParameter(String, String) using value.toString().
 void setParameter(String name, String value)
          Sets the parameter name to value.
 void setParameterValues(String name, String[] values)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Constructor Detail

HttpParameterMap

public HttpParameterMap()

HttpParameterMap

public HttpParameterMap(Map params)

HttpParameterMap

public HttpParameterMap(javax.servlet.http.HttpServletRequest sreq)
Method Detail

register

public static final void register(HttpParameterListener listener)

clear

public final void clear()

getParameter

public final String getParameter(String name)

setParameter

public final void setParameter(String name,
                               String value)
Sets the parameter name to value. If value is null, this method sets the value to the empty string. Use of this method assumes that the parameter has only one value; if you wish to give a parameter multiple values, use setParameterValues(String, String[]).

Parameters:
name - The String name of the parameter
value - The String value of the parameter
See Also:
ServletRequest.getParameter(String)

setParameter

public final void setParameter(String name,
                               Object value)
A convenience method that calls setParameter(String, String) using value.toString(). If value is null, it is converted to the empty string.

Parameters:
name - The String name of the parameter
value - The Object value of the parameter

getParameterValues

public final String[] getParameterValues(String name)

setParameterValues

public final void setParameterValues(String name,
                                     String[] values)

clearParameter

public final void clearParameter(String name)

getParameterMap

public final Map getParameterMap()

toString

public final String toString()

getQueryString

public final String getQueryString()

runListeners

public final void runListeners(javax.servlet.http.HttpServletRequest sreq)


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC