org.apache.http.params
Class DefaultedHttpParams

java.lang.Object
  extended by org.apache.http.params.AbstractHttpParams
      extended by org.apache.http.params.DefaultedHttpParams
All Implemented Interfaces:
HttpParams, HttpParamsNames

Deprecated. (4.3) use configuration classes provided 'org.apache.http.config' and 'org.apache.http.client.config'

@Deprecated
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.

Since:
4.0

Constructor Summary
DefaultedHttpParams(HttpParams local, HttpParams defaults)
          Deprecated. Create the defaulted set of HttpParams.
 
Method Summary
 HttpParams copy()
          Deprecated. Creates a copy of the local collection with the same default
 Set<String> getDefaultNames()
          Deprecated. Returns the current set of defaults names.
 HttpParams getDefaults()
          Deprecated.  
 Set<String> getLocalNames()
          Deprecated. Returns the current set of local names.
 Set<String> getNames()
          Deprecated. Returns the current set of names from both the local and default HttpParams instances.
 Object getParameter(String name)
          Deprecated. 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)
          Deprecated. Attempts to remove the parameter from the local collection.
 HttpParams setParameter(String name, Object value)
          Deprecated. 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 Detail

DefaultedHttpParams

public DefaultedHttpParams(HttpParams local,
                           HttpParams defaults)
Deprecated. 
Create the defaulted set of HttpParams.

Parameters:
local - the mutable set of HttpParams
defaults - the default set of HttpParams, not mutated by this class
Method Detail

copy

public HttpParams copy()
Deprecated. 
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)
Deprecated. 
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)
Deprecated. 
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)
Deprecated. 
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()
Deprecated. 
Returns:
the default HttpParams collection

getNames

public Set<String> getNames()
Deprecated. 
Returns the current set of names from both the local and default HttpParams instances. Changes to the underlying HttpParams intances are not reflected in the set - it is a snapshot.

Specified by:
getNames in interface HttpParamsNames
Overrides:
getNames in class AbstractHttpParams
Returns:
the combined set of names, as a Set<String>
Throws:
UnsupportedOperationException - if either the local or default HttpParams instances do not implement HttpParamsNames
Since:
4.2

getDefaultNames

public Set<String> getDefaultNames()
Deprecated. 
Returns the current set of defaults names. Changes to the underlying HttpParams are not reflected in the set - it is a snapshot.

Returns:
the names, as a Set<String>
Throws:
UnsupportedOperationException - if the default HttpParams instance does not implement HttpParamsNames
Since:
4.2

getLocalNames

public Set<String> getLocalNames()
Deprecated. 
Returns the current set of local names. Changes to the underlying HttpParams are not reflected in the set - it is a snapshot.

Returns:
the names, as a Set<String>
Throws:
UnsupportedOperationException - if the local HttpParams instance does not implement HttpParamsNames
Since:
4.2


Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.