Android - An Open Handset Alliance Project

org.apache.http.params
public class

org.apache.http.params.BasicHttpParams

java.lang.Object
	org.apache.http.params.AbstractHttpParams		HttpParams
		org.apache.http.params.BasicHttpParams	Serializable HttpLinkedParams

This class represents a collection of HTTP protocol parameters. Protocol parameters may be linked together to form a hierarchy. If a particular parameter value has not been explicitly defined in the collection itself, its value will be drawn from the parent collection of parameters.

Summary

Fields

protected HttpParams defaults The optional set of default values to defer to.

Public Constructors

					BasicHttpParams(HttpParams defaults)
					Creates a new collection of parameters with the given parent.
					BasicHttpParams()

Public Methods

				void	clear()
					Removes all parameters from this collection.
				HttpParams	copy()
					Creates a copy of these parameters.
				HttpParams	getDefaults()
					Obtains default parameters, if set.
				Object	getParameter(String name)
					Returns a parameter value with the given name.
				boolean	isParameterSet(String name)
					Returns `true` if the parameter is set at any level, `false` otherwise.
				boolean	isParameterSetLocally(String name)
					WARNING: This method is not part of the API.
				void	setDefaults(HttpParams params)
					Provides default parameters.
				HttpParams	setParameter(String name, Object value)
					Assigns the value to the parameter with the given name
				void	setParameters(String[] names, Object value)
					Assigns the value to all the parameter with the given names

Protected Methods

				void	copyParams(HttpParams target)
					Copies the locally defined parameters to the argument parameters.

Methods inherited from class org.apache.http.params.AbstractHttpParams

getBooleanParameter, getDoubleParameter, getIntParameter, getLongParameter, isParameterFalse, isParameterTrue, setBooleanParameter, setDoubleParameter, setIntParameter, setLongParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface org.apache.http.params.HttpLinkedParams

getDefaults, isParameterSetLocally, setDefaults

Methods inherited from interface org.apache.http.params.HttpParams

copy, getBooleanParameter, getDoubleParameter, getIntParameter, getLongParameter, getParameter, isParameterFalse, isParameterSet, isParameterTrue, setBooleanParameter, setDoubleParameter, setIntParameter, setLongParameter, setParameter

Details

Fields

protected HttpParams defaults

The optional set of default values to defer to.

Public Constructors

public BasicHttpParams(HttpParams defaults)

Creates a new collection of parameters with the given parent. The collection will defer to its parent for a default value if a particular parameter is not explicitly set in the collection itself.

Parameters

defaults	the parent collection to defer to, if a parameter is not explictly set in the collection itself.

public BasicHttpParams()

Public Methods

public void clear()

Removes all parameters from this collection.

public HttpParams copy()

Creates a copy of these parameters. The implementation here instantiates BasicHttpParams with the same default parameters as this object, then calls copyParams(HttpParams) to populate the copy.
Derived classes which have to change the class that is instantiated can override this method here. Derived classes which have to change how the copy is populated can override copyParams(HttpParams).

Returns

a new set of params holding a copy of the local parameters in this object. Defaults parameters available via getDefaults() are not copied.

public HttpParams getDefaults()

Obtains default parameters, if set.

Returns

the defaults, or null

public Object getParameter(String name)

Returns a parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, null value is returned.

public boolean isParameterSet(String name)

Returns true if the parameter is set at any level, false otherwise.

public boolean isParameterSetLocally(String name)

WARNING: This method is not part of the API. It is intended for internal use by the HTTP Components framework. Use with caution.

public void setDefaults(HttpParams params)

Provides default parameters.

Parameters

params	the new defaults, or `null` to unset

public HttpParams setParameter(String name, Object value)

Assigns the value to the parameter with the given name

public void setParameters(String[] names, Object value)

Assigns the value to all the parameter with the given names

Parameters

names	array of parameter name
value	parameter value

Protected Methods

protected void copyParams(HttpParams target)

Copies the locally defined parameters to the argument parameters. Default parameters accessible via getDefaults() are not copied. This method is called from copy().

Parameters

target	the parameters to which to copy

				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.
				boolean	isParameterFalse(String name)
					Returns `true` if the parameter is either not set or is `false`, `false` otherwise.
				boolean	isParameterTrue(String name)
					Returns `true` if the parameter is set and is `true`, `false` otherwise.
				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

Android - An Open Handset Alliance Project

Documentation

Goodies

org.apache.http.params.BasicHttpParams

Summary

Fields

Public Constructors

Public Methods

Protected Methods

Methods inherited from class org.apache.http.params.AbstractHttpParams

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.http.params.HttpLinkedParams

Methods inherited from interface org.apache.http.params.HttpParams

Details

Fields

protected HttpParams defaults

Public Constructors

public BasicHttpParams(HttpParams defaults)

Parameters

public BasicHttpParams()

Public Methods

public void clear()

public HttpParams copy()

Returns

public HttpParams getDefaults()

Returns

public Object getParameter(String name)

public boolean isParameterSet(String name)

public boolean isParameterSetLocally(String name)

public void setDefaults(HttpParams params)

Parameters

public HttpParams setParameter(String name, Object value)

public void setParameters(String[] names, Object value)

Parameters

Protected Methods

protected void copyParams(HttpParams target)

Parameters


e.g. "intent" or "activity"