Android
org.apache.http.params
public interface

org.apache.http.params.HttpParams

org.apache.http.params.HttpParams

Represents a collection of HTTP protocol and framework parameters.

Known Indirect Subclasses

Summary

Public Methods

          HttpParams  copy()
Creates a copy of these parameters.
          boolean  getBooleanParameter(String name, boolean defaultValue)
Returns a Boolean parameter value with the given name.
          double  getDoubleParameter(String name, double defaultValue)
Returns a Double parameter value with the given name.
          int  getIntParameter(String name, int defaultValue)
Returns an Integer parameter value with the given name.
          long  getLongParameter(String name, long defaultValue)
Returns a Long parameter value with the given name.
          Object  getParameter(String name)
Obtains the value of the given parameter.
          boolean  isParameterFalse(String name)
Checks if a boolean parameter is not set or false.
          boolean  isParameterTrue(String name)
Checks if a boolean parameter is set to true.
          boolean  removeParameter(String name)
Removes the parameter with the specified name.
          HttpParams  setBooleanParameter(String name, boolean value)
Assigns a Boolean to the parameter with the given name
          HttpParams  setDoubleParameter(String name, double value)
Assigns a Double to the parameter with the given name
          HttpParams  setIntParameter(String name, int value)
Assigns an Integer to the parameter with the given name
          HttpParams  setLongParameter(String name, long value)
Assigns a Long to the parameter with the given name
          HttpParams  setParameter(String name, Object value)
Assigns the value to the parameter with the given name.

Details

Public Methods

public HttpParams copy()

Creates a copy of these parameters.

Returns

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

public 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 the parent name.
defaultValue the default value.

Returns

  • a Boolean that represents the value of the parameter.

public 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 the parent name.
defaultValue the default value.

Returns

  • a Double that represents the value of the parameter.

public 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 the parent name.
defaultValue the default value.

Returns

  • a Integer that represents the value of the parameter.

public 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 the parent name.
defaultValue the default value.

Returns

  • a Long that represents the value of the parameter.

public Object getParameter(String name)

Obtains the value of the given parameter.

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

public boolean isParameterFalse(String name)

Checks if a boolean parameter is not set or false.

Parameters

name parameter name

Returns

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

public boolean isParameterTrue(String name)

Checks if a boolean parameter is set to true.

Parameters

name parameter name

Returns

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

public boolean removeParameter(String name)

Removes the parameter with the specified name.

Parameters

name parameter name

Returns

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

public HttpParams setBooleanParameter(String name, boolean value)

Assigns a Boolean to the parameter with the given name

Parameters

name parameter name
value parameter value

public HttpParams setDoubleParameter(String name, double value)

Assigns a Double to the parameter with the given name

Parameters

name parameter name
value parameter value

public HttpParams setIntParameter(String name, int value)

Assigns an Integer to the parameter with the given name

Parameters

name parameter name
value parameter value

public HttpParams setLongParameter(String name, long value)

Assigns a Long to the parameter with the given name

Parameters

name parameter name
value parameter value

public HttpParams setParameter(String name, Object value)

Assigns the value to the parameter with the given name.

Parameters

name parameter name
value parameter value
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56