public final class

BasicHttpParams

extends AbstractHttpParams
implements Serializable Cloneable
java.lang.Object
   ↳ org.apache.http.params.AbstractHttpParams
     ↳ org.apache.http.params.BasicHttpParams

Class Overview

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.

Summary

Public Constructors
BasicHttpParams()
Public Methods
void clear()
Removes all parameters from this collection.
Object clone()
Creates and returns a copy of this Object.
HttpParams copy()
Creates a copy of these parameters.
Object getParameter(String name)
boolean isParameterSet(String name)
boolean isParameterSetLocally(String name)
boolean removeParameter(String name)
HttpParams setParameter(String name, Object value)
void setParameters(String[] names, Object value)
Assigns the value to all the parameter with the given names
Protected Methods
void copyParams(HttpParams target)
Copies the locally defined parameters to the argument parameters.
[Expand]
Inherited Methods
From class org.apache.http.params.AbstractHttpParams
From class java.lang.Object
From interface org.apache.http.params.HttpParams

Public Constructors

public BasicHttpParams ()

Since: API Level 1

Public Methods

public void clear ()

Since: API Level 1

Removes all parameters from this collection.

public Object clone ()

Since: API Level 1

Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Returns
  • a copy of this object.
Throws
CloneNotSupportedException

public HttpParams copy ()

Since: API Level 1

Creates a copy of these parameters. The implementation here instantiates BasicHttpParams, then calls copyParams(HttpParams) to populate the copy.

Returns
  • a new set of params holding a copy of the local parameters in this object.

public Object getParameter (String name)

Since: API Level 1

public boolean isParameterSet (String name)

Since: API Level 1

public boolean isParameterSetLocally (String name)

Since: API Level 1

public boolean removeParameter (String name)

Since: API Level 1

public HttpParams setParameter (String name, Object value)

Since: API Level 1

public void setParameters (String[] names, Object value)

Since: API Level 1

Assigns the value to all the parameter with the given names

Parameters
names array of parameter name
value parameter value

Protected Methods

protected void copyParams (HttpParams target)

Since: API Level 1

Copies the locally defined parameters to the argument parameters. This method is called from copy().

Parameters
target the parameters to which to copy