Package org.apache.http.params

Class DefaultedHttpParams

java.lang.Object

org.apache.http.params.AbstractHttpParams

org.apache.http.params.DefaultedHttpParams

All Implemented Interfaces:

HttpParams

public final class DefaultedHttpParams
extends AbstractHttpParams

HttpParams implementation that delegates resolution of a parameter to the given default HttpParams instance if the parameter is not present in the local one. The state of the local collection can be mutated, whereas the default collection is treated as read-only.

Version:

$Revision: 610763 $

Author:

Oleg Kalnichevski

Constructor Summary

Constructors

Constructor	Description
DefaultedHttpParams(HttpParams local, HttpParams defaults)

Method Summary

Modifier and Type	Method	Description
HttpParams	copy()	Creates a copy of the local collection with the same default
HttpParams	getDefaults()
Object	getParameter(String name)	Retrieves the value of the parameter from the local collection and, if the parameter is not set locally, delegates its resolution to the default collection.
boolean	removeParameter(String name)	Attempts to remove the parameter from the local collection.
HttpParams	setParameter(String name, Object value)	Sets the parameter in the local collection.

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

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

Constructor Details

DefaultedHttpParams

public DefaultedHttpParams(HttpParams local,
HttpParams defaults)

Method Details

copy

public HttpParams copy()

Creates a copy of the local collection with the same default

Returns:

a new set of parameters holding the same values as this one

getParameter

public Object getParameter(String name)

Retrieves the value of the parameter from the local collection and, if the parameter is not set locally, delegates its resolution to the default collection.

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)

removeParameter

public boolean removeParameter(String name)

Attempts to remove the parameter from the local collection. This method does not modify the default collection.

Parameters:

name - parameter name

Returns:

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

setParameter

public HttpParams setParameter(String name,
Object value)

Sets the parameter in the local collection. This method does not modify the default collection.

Parameters:

name - parameter name

value - parameter value

getDefaults

public HttpParams getDefaults()