Save This Page
Home » HttpComponents-Core-4.0.1 » org.apache.http.params » [javadoc | source]
org.apache.http.params
public interface: HttpParams [javadoc | source]

All Known Implementing Classes:
    DefaultHttpParams, BasicHttpParams, DefaultedHttpParams, AbstractHttpParams

HttpParams interface represents a collection of immutable values that define a runtime behavior of a component. HTTP parameters should be simple objects: integers, doubles, strings, collections and objects that remain immutable at runtime. HttpParams is expected to be used in the 'write once - ready many' mode. Once initialized HTTP parameters are not expected to mutate in the course of HTTP message processing.

The purpose of this intreface is to define a behavior of other components. Usually each complex component has its own HTTP parameter collection.

Instances of this interface can be linked together to form a hierarchy. In the simplest form one set of parameters can use content of another one to obtain default values of parameters not present in the local set.

Method from org.apache.http.params.HttpParams Summary:
copy,   getBooleanParameter,   getDoubleParameter,   getIntParameter,   getLongParameter,   getParameter,   isParameterFalse,   isParameterTrue,   removeParameter,   setBooleanParameter,   setDoubleParameter,   setIntParameter,   setLongParameter,   setParameter
Method from org.apache.http.params.HttpParams Detail:
 public HttpParams copy()
    Creates a copy of these parameters.
 public boolean getBooleanParameter(String name,
    boolean defaultValue)
    Returns a Boolean  parameter value with the given name. 
If the parameter is not explicitly set, the default value is returned.
 public double getDoubleParameter(String name,
    double defaultValue)
    Returns a Double  parameter value with the given name. 
If the parameter is not explicitly set, the default value is returned.
 public int getIntParameter(String name,
    int defaultValue)
    Returns an Integer  parameter value with the given name. 
If the parameter is not explicitly set, the default value is returned.
 public long getLongParameter(String name,
    long defaultValue)
    Returns a Long  parameter value with the given name. 
If the parameter is not explicitly set, the default value is returned.
 public Object getParameter(String name)
    Obtains the value of the given parameter.
 public boolean isParameterFalse(String name)
    Checks if a boolean parameter is not set or false.
 public boolean isParameterTrue(String name)
    Checks if a boolean parameter is set to true.
 public boolean removeParameter(String name)
    Removes the parameter with the specified name.
 public HttpParams setBooleanParameter(String name,
    boolean value)
    Assigns a Boolean  to the parameter with the given name
 public HttpParams setDoubleParameter(String name,
    double value)
    Assigns a Double  to the parameter with the given name
 public HttpParams setIntParameter(String name,
    int value)
    Assigns an Integer  to the parameter with the given name
 public HttpParams setLongParameter(String name,
    long value)
    Assigns a Long  to the parameter with the given name
 public HttpParams setParameter(String name,
    Object value)
    Assigns the value to the parameter with the given name.