Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.meterware.httpunit
Class ParameterHolder  view ParameterHolder download ParameterHolder.java

java.lang.Object
  extended bycom.meterware.httpunit.ParameterHolder
Direct Known Subclasses:
UncheckedParameterHolder, WebRequestSource

abstract class ParameterHolder
extends java.lang.Object

This abstract class is extended by classes which hold parameters for web requests. Note that it is an abstract class rather than an interface in order to keep its methods package-local.


Constructor Summary
(package private) ParameterHolder()
           
 
Method Summary
(package private)  java.lang.String getCharacterSet()
          Returns the character set encoding for the request.
(package private) abstract  java.lang.String[] getParameterNames()
          Returns an array of all parameter names in this collection.
(package private) abstract  java.lang.String[] getParameterValues(java.lang.String name)
          Returns the multiple default values of the named parameter.
(package private)  boolean isFileParameter(java.lang.String name)
          Returns true if the specified name is that of a file parameter.
(package private) abstract  boolean isSubmitAsMime()
           
(package private) abstract  void recordParameters(ParameterProcessor processor)
          Iterates through the parameters in this holder, recording them in the supplied parameter processor.
(package private) abstract  void recordPredefinedParameters(ParameterProcessor processor)
          Iterates through the fixed, predefined parameters in this holder, recording them in the supplied parameter processor.\ These parameters always go on the URL, no matter what encoding method is used.
(package private) abstract  void removeParameter(java.lang.String name)
          Removes a parameter name from this collection.
(package private)  void selectImageButtonPosition(SubmitButton imageButton, int x, int y)
          Specifies the position at which an image button (if any) was clicked.
(package private) abstract  void setParameter(java.lang.String name, java.lang.String value)
          Sets the value of a parameter in a web request.
(package private) abstract  void setParameter(java.lang.String name, java.lang.String[] values)
          Sets the multiple values of a parameter in a web request.
(package private) abstract  void setParameter(java.lang.String name, UploadFileSpec[] files)
          Sets the multiple values of a file upload parameter in a web request.
(package private) abstract  void setSubmitAsMime(boolean mimeEncoded)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParameterHolder

ParameterHolder()
Method Detail

selectImageButtonPosition

void selectImageButtonPosition(SubmitButton imageButton,
                               int x,
                               int y)
Specifies the position at which an image button (if any) was clicked. This default implementation does nothing.


recordPredefinedParameters

abstract void recordPredefinedParameters(ParameterProcessor processor)
                                  throws java.io.IOException
Iterates through the fixed, predefined parameters in this holder, recording them in the supplied parameter processor.\ These parameters always go on the URL, no matter what encoding method is used.


recordParameters

abstract void recordParameters(ParameterProcessor processor)
                        throws java.io.IOException
Iterates through the parameters in this holder, recording them in the supplied parameter processor.


getParameterNames

abstract java.lang.String[] getParameterNames()
Returns an array of all parameter names in this collection.


getParameterValues

abstract java.lang.String[] getParameterValues(java.lang.String name)
Returns the multiple default values of the named parameter.


removeParameter

abstract void removeParameter(java.lang.String name)
Removes a parameter name from this collection.


setParameter

abstract void setParameter(java.lang.String name,
                           java.lang.String value)
Sets the value of a parameter in a web request.


setParameter

abstract void setParameter(java.lang.String name,
                           java.lang.String[] values)
Sets the multiple values of a parameter in a web request.


setParameter

abstract void setParameter(java.lang.String name,
                           UploadFileSpec[] files)
Sets the multiple values of a file upload parameter in a web request.


isFileParameter

boolean isFileParameter(java.lang.String name)
Returns true if the specified name is that of a file parameter. The default implementation returns false.


getCharacterSet

java.lang.String getCharacterSet()
Returns the character set encoding for the request.


isSubmitAsMime

abstract boolean isSubmitAsMime()

setSubmitAsMime

abstract void setSubmitAsMime(boolean mimeEncoded)