Added in API level 1
Deprecated in API level 22

HttpParams

public interface HttpParams

org.apache.http.params.HttpParams

This interface was deprecated in API level 22.
Please use URL.openConnection() instead. Please visit this webpage for further details.

Represents a collection of HTTP protocol and framework parameters.

Summary

Public methods

abstract HttpParams copy()

Creates a copy of these parameters.

abstract boolean getBooleanParameter(String name, boolean defaultValue)

Returns a Boolean parameter value with the given name.

abstract double getDoubleParameter(String name, double defaultValue)

Returns a Double parameter value with the given name.

abstract int getIntParameter(String name, int defaultValue)

Returns an Integer parameter value with the given name.

abstract long getLongParameter(String name, long defaultValue)

Returns a Long parameter value with the given name.

abstract Object getParameter(String name)

Obtains the value of the given parameter.

abstract boolean isParameterFalse(String name)

Checks if a boolean parameter is not set or false.

abstract boolean isParameterTrue(String name)

Checks if a boolean parameter is set to true.

abstract boolean removeParameter(String name)

Removes the parameter with the specified name.

abstract HttpParams setBooleanParameter(String name, boolean value)

Assigns a Boolean to the parameter with the given name

abstract HttpParams setDoubleParameter(String name, double value)

Assigns a Double to the parameter with the given name

abstract HttpParams setIntParameter(String name, int value)

Assigns an Integer to the parameter with the given name

abstract HttpParams setLongParameter(String name, long value)

Assigns a Long to the parameter with the given name

abstract HttpParams setParameter(String name, Object value)

Assigns the value to the parameter with the given name.

Public methods

copy

Added in API level 1 
public abstract HttpParams copy ()

Creates a copy of these parameters.

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

getBooleanParameter

Added in API level 1 
public abstract boolean getBooleanParameter (String name, 
                boolean defaultValue)

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.

getDoubleParameter

Added in API level 1 
public abstract double getDoubleParameter (String name, 
                double defaultValue)

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.

getIntParameter

Added in API level 1 
public abstract int getIntParameter (String name, 
                int defaultValue)

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.

getLongParameter

Added in API level 1 
public abstract long getLongParameter (String name, 
                long defaultValue)

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.

getParameter

Added in API level 1 
public abstract Object getParameter (String name)

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

isParameterFalse

Added in API level 1 
public abstract boolean isParameterFalse (String name)

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

isParameterTrue

Added in API level 1 
public abstract boolean isParameterTrue (String name)

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

removeParameter

Added in API level 1 
public abstract boolean removeParameter (String name)

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.

setBooleanParameter

Added in API level 1 
public abstract HttpParams setBooleanParameter (String name, 
                boolean value)

Assigns a Boolean to the parameter with the given name

Parameters
name String: parameter name
value boolean: parameter value
Returns
HttpParams

setDoubleParameter

Added in API level 1 
public abstract HttpParams setDoubleParameter (String name, 
                double value)

Assigns a Double to the parameter with the given name

Parameters
name String: parameter name
value double: parameter value
Returns
HttpParams

setIntParameter

Added in API level 1 
public abstract HttpParams setIntParameter (String name, 
                int value)

Assigns an Integer to the parameter with the given name

Parameters
name String: parameter name
value int: parameter value
Returns
HttpParams

setLongParameter

Added in API level 1 
public abstract HttpParams setLongParameter (String name, 
                long value)

Assigns a Long to the parameter with the given name

Parameters
name String: parameter name
value long: parameter value
Returns
HttpParams

setParameter

Added in API level 1 
public abstract HttpParams setParameter (String name, 
                Object value)

Assigns the value to the parameter with the given name.

Parameters
name String: parameter name
value Object: parameter value
Returns
HttpParams