org.apache.commons.httpclient.params

Class DefaultHttpParams

public class DefaultHttpParams extends Object implements HttpParams, Serializable, Cloneable

This class represents a collection of HTTP protocol parameters. Protocol parameters may be linked together to form a hierarchy. If a particular parameter value has not been explicitly defined in the collection itself, its value will be drawn from the parent collection of parameters.

Since: 3.0

Version: $Revision: 510589 $

Author: Oleg Kalnichevski

Constructor Summary
	DefaultHttpParams(HttpParams defaults) Creates a new collection of parameters with the given parent.
	DefaultHttpParams() Creates a new collection of parameters with the collection returned by getDefaultParams as a parent.

Method Summary
void	clear() Removes all parameters from this collection.
Object	clone() Clones this collection of parameters.
boolean	getBooleanParameter(String name, boolean defaultValue)
static HttpParams	getDefaultParams() Gets the default HttpParams to be used.
HttpParams	getDefaults()
double	getDoubleParameter(String name, double defaultValue)
int	getIntParameter(String name, int defaultValue)
long	getLongParameter(String name, long defaultValue)
Object	getParameter(String name)
boolean	isParameterFalse(String name)
boolean	isParameterSet(String name)
boolean	isParameterSetLocally(String name)
boolean	isParameterTrue(String name)
void	setBooleanParameter(String name, boolean value)
void	setDefaults(HttpParams params)
void	setDoubleParameter(String name, double value)
static void	setHttpParamsFactory(HttpParamsFactory httpParamsFactory) Sets the factory that will provide the default HttpParams.
void	setIntParameter(String name, int value)
void	setLongParameter(String name, long value)
void	setParameter(String name, Object value)
void	setParameters(String[] names, Object value) Assigns the value to all the parameter with the given names

Constructor Detail

DefaultHttpParams

public DefaultHttpParams(HttpParams defaults)

Creates a new collection of parameters with the given parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself.

Parameters: defaults the parent collection to defer to, if a parameter is not explictly set in the collection itself.

See Also: java.io.Serializable java.lang.Object#clone()

getBooleanParameter

public boolean getBooleanParameter(String name, boolean defaultValue)

getDefaultParams

public static HttpParams getDefaultParams()

Gets the default HttpParams to be used.

Returns: the value returned from HttpParamsFactory#getDefaultParams()

Parameters: httpParamsFactory an instance of HttpParamsFactory

Parameters: names array of parameter name value parameter value