Top Description Constructors Methods
org.apache.http.params

public abstract Class AbstractHttpParams

extends Object
implements HttpParams, HttpParamsNames
Class Inheritance
All Implemented Interfaces
org.apache.http.params.HttpParamsNames, org.apache.http.params.HttpParams
Known Direct Subclasses
org.apache.http.params.BasicHttpParams, org.apache.http.params.DefaultedHttpParams
Annotations
@Deprecated
Imports
java.util.Set

Deprecated

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

Abstract base class for parameter collections. Type specific setters and getters are mapped to the abstract, generic getters and setters.
Since
4.0

Constructor Summary

AccessConstructor and Description
protected
AbstractHttpParams()

Instantiates parameters.

Method Summary

Modifier and TypeMethod and Description
public boolean
getBooleanParameter(final String
the parent name.
name, final boolean
the default value.
defaultValue)

Implements org.apache.http.params.HttpParams.getBooleanParameter.

Returns a Boolean parameter value with the given name.
public double
getDoubleParameter(final String
the parent name.
name, final double
the default value.
defaultValue)

Implements org.apache.http.params.HttpParams.getDoubleParameter.

Returns a Double parameter value with the given name.
public int
getIntParameter(final String
the parent name.
name, final int
the default value.
defaultValue)

Implements org.apache.http.params.HttpParams.getIntParameter.

Returns an Integer parameter value with the given name.
public long
getLongParameter(final String
the parent name.
name, final long
the default value.
defaultValue)

Implements org.apache.http.params.HttpParams.getLongParameter.

Returns a Long parameter value with the given name.
public Set<String>
getNames()

Implements org.apache.http.params.HttpParamsNames.getNames.

Returns the current set of names; in the case of stacked parameters, returns the names from all the participating HttpParams instances.
public boolean
isParameterFalse(final String
parameter name
name)

Implements org.apache.http.params.HttpParams.isParameterFalse.

Checks if a boolean parameter is not set or false.
public boolean
isParameterTrue(final String
parameter name
name)

Implements org.apache.http.params.HttpParams.isParameterTrue.

Checks if a boolean parameter is set to true.
public HttpParams
setBooleanParameter(final String
parameter name
name, final boolean
parameter value
value)

Implements org.apache.http.params.HttpParams.setBooleanParameter.

Deprecated as a consequence of HttpParams being deprecated.
Assigns a Boolean to the parameter with the given name
public HttpParams
setDoubleParameter(final String
parameter name
name, final double
parameter value
value)

Implements org.apache.http.params.HttpParams.setDoubleParameter.

Deprecated as a consequence of HttpParams being deprecated.
Assigns a Double to the parameter with the given name
public HttpParams
setIntParameter(final String
parameter name
name, final int
parameter value
value)

Implements org.apache.http.params.HttpParams.setIntParameter.

Deprecated as a consequence of HttpParams being deprecated.
Assigns an Integer to the parameter with the given name
public HttpParams
setLongParameter(final String
parameter name
name, final long
parameter value
value)

Implements org.apache.http.params.HttpParams.setLongParameter.

Deprecated as a consequence of HttpParams being deprecated.
Assigns a Long to the parameter with the given name
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AbstractHttpParamsback to summary
protected AbstractHttpParams()

Instantiates parameters.

Method Detail

getBooleanParameterback to summary
public boolean getBooleanParameter(final String name, final boolean defaultValue)

Implements org.apache.http.params.HttpParams.getBooleanParameter.

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

Returns a Boolean parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

Parameters
name:String

the parent name.

defaultValue:boolean

the default value.

Returns:boolean

a Boolean that represents the value of the parameter.

Annotations
@Override
getDoubleParameterback to summary
public double getDoubleParameter(final String name, final double defaultValue)

Implements org.apache.http.params.HttpParams.getDoubleParameter.

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

Returns a Double parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

Parameters
name:String

the parent name.

defaultValue:double

the default value.

Returns:double

a Double that represents the value of the parameter.

Annotations
@Override
getIntParameterback to summary
public int getIntParameter(final String name, final int defaultValue)

Implements org.apache.http.params.HttpParams.getIntParameter.

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

Returns an Integer parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

Parameters
name:String

the parent name.

defaultValue:int

the default value.

Returns:int

a Integer that represents the value of the parameter.

Annotations
@Override
getLongParameterback to summary
public long getLongParameter(final String name, final long defaultValue)

Implements org.apache.http.params.HttpParams.getLongParameter.

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

Returns a Long parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

Parameters
name:String

the parent name.

defaultValue:long

the default value.

Returns:long

a Long that represents the value of the parameter.

Annotations
@Override
getNamesback to summary
public Set<String> getNames()

Implements org.apache.http.params.HttpParamsNames.getNames.

Doc from org.apache.http.params.HttpParamsNames.getNames.

Returns the current set of names; in the case of stacked parameters, returns the names from all the participating HttpParams instances. Changes to the underlying HttpParams are not reflected in the set - it is a snapshot.

Dummy implementation - must be overridden by subclasses.

Returns:Set<String>

the names, as a Set<String>

Annotations
@Override
Exceptions
UnsupportedOperationException:
- always
Since
4.2
isParameterFalseback to summary
public boolean isParameterFalse(final String name)

Implements org.apache.http.params.HttpParams.isParameterFalse.

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

Checks if a boolean parameter is not set or false.

Parameters
name:String

parameter name

Returns:boolean

true if the parameter is either not set or set to value false, false if it is set to true

Annotations
@Override
isParameterTrueback to summary
public boolean isParameterTrue(final String name)

Implements org.apache.http.params.HttpParams.isParameterTrue.

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

Checks if a boolean parameter is set to true.

Parameters
name:String

parameter name

Returns:boolean

true if the parameter is set to value true, false if it is not set or set to false

Annotations
@Override
setBooleanParameterback to summary
public HttpParams setBooleanParameter(final String name, final boolean value)

Implements org.apache.http.params.HttpParams.setBooleanParameter.

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

Deprecated

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

Assigns a Boolean to the parameter with the given name

Parameters
name:String

parameter name

value:boolean

parameter value

Annotations
@Override
setDoubleParameterback to summary
public HttpParams setDoubleParameter(final String name, final double value)

Implements org.apache.http.params.HttpParams.setDoubleParameter.

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

Deprecated

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

Assigns a Double to the parameter with the given name

Parameters
name:String

parameter name

value:double

parameter value

Annotations
@Override
setIntParameterback to summary
public HttpParams setIntParameter(final String name, final int value)

Implements org.apache.http.params.HttpParams.setIntParameter.

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

Deprecated

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

Assigns an Integer to the parameter with the given name

Parameters
name:String

parameter name

value:int

parameter value

Annotations
@Override
setLongParameterback to summary
public HttpParams setLongParameter(final String name, final long value)

Implements org.apache.http.params.HttpParams.setLongParameter.

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

Deprecated

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

Assigns a Long to the parameter with the given name

Parameters
name:String

parameter name

value:long

parameter value

Annotations
@Override