Top Description Fields Constructors Methods
org.apache.http.params

public Class SyncBasicHttpParams

extends BasicHttpParams
Class Inheritance
Annotations
@Contract
threading:SAFE
@Deprecated
Imports
org.apache.http.annotation.ThreadingBehavior, .Contract

Deprecated

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

Thread-safe extension of the BasicHttpParams.
Since
4.1

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides org.apache.http.params.BasicHttpParams.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
SyncBasicHttpParams()

Method Summary

Modifier and TypeMethod and Description
public synchronized void
clear()

Overrides org.apache.http.params.BasicHttpParams.clear.

Removes all parameters from this collection.
public synchronized Object
clone()

Overrides org.apache.http.params.BasicHttpParams.clone.

Clones the instance.
public synchronized Object
getParameter(final String
the parent name.
name)

Overrides org.apache.http.params.BasicHttpParams.getParameter.

Implements org.apache.http.params.HttpParams.getParameter.

Obtains the value of the given parameter.
public synchronized boolean
isParameterSet(final String
parameter name
name)

Overrides org.apache.http.params.BasicHttpParams.isParameterSet.

Is the parameter set?
public synchronized boolean
isParameterSetLocally(final String
parameter name
name)

Overrides org.apache.http.params.BasicHttpParams.isParameterSetLocally.

Is the parameter set in this object?
public synchronized boolean
removeParameter(final String
parameter name
name)

Overrides org.apache.http.params.BasicHttpParams.removeParameter.

Implements org.apache.http.params.HttpParams.removeParameter.

Removes the parameter with the specified name.
public synchronized HttpParams
setParameter(final String
parameter name
name, final Object
parameter value
value)

Overrides org.apache.http.params.BasicHttpParams.setParameter.

Implements org.apache.http.params.HttpParams.setParameter.

Deprecated as a consequence of HttpParams being deprecated.
Assigns the value to the parameter with the given name.
public synchronized void
setParameters(final String[]
array of parameter names
names, final Object
parameter value
value)

Overrides org.apache.http.params.BasicHttpParams.setParameters.

Assigns the value to all the parameter with the given names
Inherited from org.apache.http.params.BasicHttpParams:
copycopyParamsgetNamestoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.apache.http.params.BasicHttpParams.serialVersionUID.

Constructor Detail

SyncBasicHttpParamsback to summary
public SyncBasicHttpParams()

Method Detail

clearback to summary
public synchronized void clear()

Overrides org.apache.http.params.BasicHttpParams.clear.

Doc from org.apache.http.params.BasicHttpParams.clear.

Removes all parameters from this collection.

Annotations
@Override
cloneback to summary
public synchronized Object clone() throws CloneNotSupportedException

Overrides org.apache.http.params.BasicHttpParams.clone.

Doc from org.apache.http.params.BasicHttpParams.clone.

Clones the instance. Uses copyParams(HttpParams) to copy the parameters.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
Exceptions
CloneNotSupportedException:

Doc from java.lang.Object.clone.

if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

getParameterback to summary
public synchronized Object getParameter(final String name)

Overrides org.apache.http.params.BasicHttpParams.getParameter.

Implements org.apache.http.params.HttpParams.getParameter.

Doc from org.apache.http.params.HttpParams.getParameter.

Obtains the value of the given parameter.

Parameters
name:String

the parent name.

Returns:Object

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

Annotations
@Override
isParameterSetback to summary
public synchronized boolean isParameterSet(final String name)

Overrides org.apache.http.params.BasicHttpParams.isParameterSet.

Doc from org.apache.http.params.BasicHttpParams.isParameterSet.

Is the parameter set?

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

Also @see isParameterSetLocally(String)

Parameters
name:String

parameter name

Returns:boolean

true if parameter is defined and non-null

Annotations
@Override
isParameterSetLocallyback to summary
public synchronized boolean isParameterSetLocally(final String name)

Overrides org.apache.http.params.BasicHttpParams.isParameterSetLocally.

Doc from org.apache.http.params.BasicHttpParams.isParameterSetLocally.

Is the parameter set in this object?

The parameter value is fetched directly.

Also @see isParameterSet(String)

Parameters
name:String

parameter name

Returns:boolean

true if parameter is defined and non-null

Annotations
@Override
removeParameterback to summary
public synchronized boolean removeParameter(final String name)

Overrides org.apache.http.params.BasicHttpParams.removeParameter.

Implements org.apache.http.params.HttpParams.removeParameter.

Doc from org.apache.http.params.HttpParams.removeParameter.

Removes the parameter with the specified name.

Parameters
name:String

parameter name

Returns:boolean

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

Annotations
@Override
setParameterback to summary
public synchronized HttpParams setParameter(final String name, final Object value)

Overrides org.apache.http.params.BasicHttpParams.setParameter.

Implements org.apache.http.params.HttpParams.setParameter.

Doc from org.apache.http.params.HttpParams.setParameter.

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

Assigns the value to the parameter with the given name.

Parameters
name:String

parameter name

value:Object

parameter value

Annotations
@Override
setParametersback to summary
public synchronized void setParameters(final String[] names, final Object value)

Overrides org.apache.http.params.BasicHttpParams.setParameters.

Doc from org.apache.http.params.BasicHttpParams.setParameters.

Assigns the value to all the parameter with the given names

Parameters
names:String[]

array of parameter names

value:Object

parameter value

Annotations
@Override