FileDocCategorySizeDatePackage
HttpParams.javaAPI DocAndroid 1.5 API6124Wed May 06 22:41:10 BST 2009org.apache.http.params

HttpParams

public interface HttpParams
Represents a collection of HTTP protocol and framework parameters.
author
Oleg Kalnichevski
version
$Revision: 610763 $
since
4.0

Fields Summary
Constructors Summary
Methods Summary
public org.apache.http.params.HttpParamscopy()
Creates a copy of these parameters.

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

public booleangetBooleanParameter(java.lang.String name, boolean defaultValue)
Returns a {@link Boolean} parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

param
name the parent name.
param
defaultValue the default value.
return
a {@link Boolean} that represents the value of the parameter.
see
#setBooleanParameter(String, boolean)

public doublegetDoubleParameter(java.lang.String name, double defaultValue)
Returns a {@link Double} parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

param
name the parent name.
param
defaultValue the default value.
return
a {@link Double} that represents the value of the parameter.
see
#setDoubleParameter(String, double)

public intgetIntParameter(java.lang.String name, int defaultValue)
Returns an {@link Integer} parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

param
name the parent name.
param
defaultValue the default value.
return
a {@link Integer} that represents the value of the parameter.
see
#setIntParameter(String, int)

public longgetLongParameter(java.lang.String name, long defaultValue)
Returns a {@link Long} parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

param
name the parent name.
param
defaultValue the default value.
return
a {@link Long} that represents the value of the parameter.
see
#setLongParameter(String, long)

public java.lang.ObjectgetParameter(java.lang.String name)
Obtains the value of the given parameter.

param
name the parent name.
return
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
#setParameter(String, Object)

public booleanisParameterFalse(java.lang.String name)
Checks if a boolean parameter is not set or false.

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

public booleanisParameterTrue(java.lang.String name)
Checks if a boolean parameter is set to true.

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

public booleanremoveParameter(java.lang.String name)
Removes the parameter with the specified name.

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

public org.apache.http.params.HttpParamssetBooleanParameter(java.lang.String name, boolean value)
Assigns a {@link Boolean} to the parameter with the given name

param
name parameter name
param
value parameter value

public org.apache.http.params.HttpParamssetDoubleParameter(java.lang.String name, double value)
Assigns a {@link Double} to the parameter with the given name

param
name parameter name
param
value parameter value

public org.apache.http.params.HttpParamssetIntParameter(java.lang.String name, int value)
Assigns an {@link Integer} to the parameter with the given name

param
name parameter name
param
value parameter value

public org.apache.http.params.HttpParamssetLongParameter(java.lang.String name, long value)
Assigns a {@link Long} to the parameter with the given name

param
name parameter name
param
value parameter value

public org.apache.http.params.HttpParamssetParameter(java.lang.String name, java.lang.Object value)
Assigns the value to the parameter with the given name.

param
name parameter name
param
value parameter value