BasicHttpParams Class Reference

This class represents a collection of HTTP protocol parameters. More...

Inheritance diagram for BasicHttpParams:

Description

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.

Author

Oleg Kalnichevski

Version

Revision

610464

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
Object	getParameter (final String name)
	Obtains the value of the given parameter. More...
HttpParams	setParameter (final String name, final Object value)
	Assigns the value to the parameter with the given name. More...
boolean	removeParameter (String name)
	Removes the parameter with the specified name. More...
void	setParameters (final String[] names, final Object value)
	Assigns the value to all the parameter with the given names. More...
void	clear ()
	Removes all parameters from this collection.
HttpParams	copy ()
	Creates a copy of these parameters. More...
Public Member Functions inherited from AbstractHttpParams
long	getLongParameter (final String name, long defaultValue)
	Returns a Long parameter value with the given name. More...
HttpParams	setLongParameter (final String name, long value)
	Assigns a Long to the parameter with the given name. More...
int	getIntParameter (final String name, int defaultValue)
	Returns an Integer parameter value with the given name. More...
HttpParams	setIntParameter (final String name, int value)
	Assigns an Integer to the parameter with the given name. More...
double	getDoubleParameter (final String name, double defaultValue)
	Returns a Double parameter value with the given name. More...
HttpParams	setDoubleParameter (final String name, double value)
	Assigns a Double to the parameter with the given name. More...
boolean	getBooleanParameter (final String name, boolean defaultValue)
	Returns a Boolean parameter value with the given name. More...
HttpParams	setBooleanParameter (final String name, boolean value)
	Assigns a Boolean to the parameter with the given name. More...
boolean	isParameterTrue (final String name)
	Checks if a boolean parameter is set to true. More...
boolean	isParameterFalse (final String name)
	Checks if a boolean parameter is not set or false. More...

Protected Member Functions
void	copyParams (HttpParams target)
	Copies the locally defined parameters to the argument parameters. More...
Protected Member Functions inherited from AbstractHttpParams
	AbstractHttpParams ()
	Instantiates parameters.

Member Function Documentation

getParameter()

Object getParameter

(

final String

name

)

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

See also

setParameter(String, Object)

Implements HttpParams.

setParameter()

HttpParams setParameter	(	final String	name,
		final Object	value
	)

Parameters

name	parameter name
value	parameter value

Implements HttpParams.

removeParameter()

boolean removeParameter

(

String

name

)

Parameters

name	parameter name

Returns

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

Implements HttpParams.

setParameters()

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

Parameters

names	array of parameter name
value	parameter value

copy()

HttpParams copy

(

)

The implementation here instantiates BasicHttpParams, then calls copyParams() to populate the copy.

Returns

a new set of params holding a copy of the local parameters in this object.

Implements HttpParams.

copyParams()

void copyParams ( HttpParams  target )

protected

This method is called from copy().

Parameters

target

the parameters to which to copy