org.apache.http.params
Class BasicHttpParams

java.lang.Object
  org.apache.http.params.AbstractHttpParams
      org.apache.http.params.BasicHttpParams

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, HttpParams

Direct Known Subclasses:

SyncBasicHttpParams

public class BasicHttpParams
extends AbstractHttpParams
implements java.io.Serializable, java.lang.Cloneable

Default implementation of HttpParams interface.

Please note access to the internal structures of this class is not synchronized and therefore this class may be thread-unsafe.

Since:

4.0

See Also:

Serialized Form

Constructor Summary

BasicHttpParams()

Method Summary

void	clear() Removes all parameters from this collection.
java.lang.Object	clone()
HttpParams	copy() Deprecated.
protected void	copyParams(HttpParams target) Copies the locally defined parameters to the argument parameters.
java.lang.Object	getParameter(java.lang.String name) Obtains the value of the given parameter.
boolean	isParameterSet(java.lang.String name) Is the parameter set?
boolean	isParameterSetLocally(java.lang.String name) Is the parameter set in this object?
boolean	removeParameter(java.lang.String name) Removes the parameter with the specified name.
HttpParams	setParameter(java.lang.String name, java.lang.Object value) Assigns the value to the parameter with the given name.
void	setParameters(java.lang.String[] names, java.lang.Object value) Assigns the value to all the parameter with the given names

Methods inherited from class org.apache.http.params.AbstractHttpParams

getBooleanParameter, getDoubleParameter, getIntParameter, getLongParameter, isParameterFalse, isParameterTrue, setBooleanParameter, setDoubleParameter, setIntParameter, setLongParameter

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicHttpParams

public BasicHttpParams()

Method Detail

getParameter

public java.lang.Object getParameter(java.lang.String name)

Description copied from interface: HttpParams

Obtains the value of the given parameter.

Specified by:

getParameter in interface HttpParams

Parameters:

name - the parent name.

Returns:

an object that represents the value of the parameter, null if the parameter is not set or if it is explicitly set to null

See Also:

HttpParams.setParameter(String, Object)

setParameter

public HttpParams setParameter(java.lang.String name,
                               java.lang.Object value)

Description copied from interface: HttpParams

Assigns the value to the parameter with the given name.

Specified by:

setParameter in interface HttpParams

Parameters:

name - parameter name

value - parameter value

removeParameter

public boolean removeParameter(java.lang.String name)

Description copied from interface: HttpParams

Removes the parameter with the specified name.

Specified by:

removeParameter in interface HttpParams

Parameters:

name - parameter name

Returns:

true if the parameter existed and has been removed, false else.

setParameters

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

Assigns the value to all the parameter with the given names

Parameters:

names - array of parameter names

value - parameter value

isParameterSet

public boolean isParameterSet(java.lang.String name)

Is the parameter set?

Uses getParameter(String) (which is overrideable) to fetch the parameter value, if any.

Also @see isParameterSetLocally(String)

Parameters:

name - parameter name

Returns:

true if parameter is defined and non-null

isParameterSetLocally

public boolean isParameterSetLocally(java.lang.String name)

Is the parameter set in this object?

The parameter value is fetched directly.

Also @see isParameterSet(String)

Parameters:

name - parameter name

Returns:

true if parameter is defined and non-null

clear

public void clear()

Removes all parameters from this collection.

copy

public HttpParams copy()

Deprecated.

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

Specified by:

copy in interface HttpParams

Returns:

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

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

copyParams

protected void copyParams(HttpParams target)

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

Parameters:

target - the parameters to which to copy