org.apache.http.params
Class BasicHttpParams

java.lang.Object
  extended by org.apache.http.params.AbstractHttpParams
      extended by org.apache.http.params.BasicHttpParams
All Implemented Interfaces:
Serializable, Cloneable, HttpParams, HttpParamsNames
Direct Known Subclasses:
SyncBasicHttpParams

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

@Deprecated
@ThreadSafe
public class BasicHttpParams
extends AbstractHttpParams
implements Serializable, 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()
          Deprecated.  
 
Method Summary
 void clear()
          Deprecated. Removes all parameters from this collection.
 Object clone()
          Deprecated. Clones the instance.
 HttpParams copy()
          Deprecated. Creates a copy of these parameters.
 void copyParams(HttpParams target)
          Deprecated. Copies the locally defined parameters to the argument parameters.
 Set<String> getNames()
          Deprecated. Returns the current set of names.
 Object getParameter(String name)
          Deprecated. Obtains the value of the given parameter.
 boolean isParameterSet(String name)
          Deprecated. Is the parameter set?
 boolean isParameterSetLocally(String name)
          Deprecated. Is the parameter set in this object?
 boolean removeParameter(String name)
          Deprecated. Removes the parameter with the specified name.
 HttpParams setParameter(String name, Object value)
          Deprecated. Assigns the value to the parameter with the given name.
 void setParameters(String[] names, Object value)
          Deprecated. 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()
Deprecated. 
Method Detail

getParameter

public Object getParameter(String name)
Deprecated. 
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(String name,
                               Object value)
Deprecated. 
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(String name)
Deprecated. 
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(String[] names,
                          Object value)
Deprecated. 
Assigns the value to all the parameter with the given names

Parameters:
names - array of parameter names
value - parameter value

isParameterSet

public boolean isParameterSet(String name)
Deprecated. 
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(String name)
Deprecated. 
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()
Deprecated. 
Removes all parameters from this collection.


copy

public HttpParams copy()
Deprecated. 
Creates a copy of these parameters. This implementation calls clone().

Specified by:
copy in interface HttpParams
Returns:
a new set of params holding a copy of the local parameters in this object.
Throws:
UnsupportedOperationException - if the clone() fails

clone

public Object clone()
             throws CloneNotSupportedException
Deprecated. 
Clones the instance. Uses copyParams(HttpParams) to copy the parameters.

Overrides:
clone in class Object
Throws:
CloneNotSupportedException

copyParams

public void copyParams(HttpParams target)
Deprecated. 
Copies the locally defined parameters to the argument parameters. This method is called from clone().

Parameters:
target - the parameters to which to copy
Since:
4.2

getNames

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

Specified by:
getNames in interface HttpParamsNames
Overrides:
getNames in class AbstractHttpParams
Returns:
the names, as a Set<String>
Since:
4.2


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