• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
HttpParams Interface Reference

Represents a collection of HTTP protocol and framework parameters. More...

Inheritance diagram for HttpParams:
AbstractHttpParams ClientParamsStack BasicHttpParams DefaultedHttpParams

Description

Author
Oleg Kalnichevski
Version
Revision
610763
Since
4.0

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

Member Function Documentation

◆ getParameter()

Object getParameter ( String  name)
Parameters
namethe 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)

Implemented in ClientParamsStack, DefaultedHttpParams, and BasicHttpParams.

◆ setParameter()

HttpParams setParameter ( String  name,
Object  value 
)
Parameters
nameparameter name
valueparameter value

Implemented in ClientParamsStack, DefaultedHttpParams, and BasicHttpParams.

◆ copy()

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

Implemented in ClientParamsStack, BasicHttpParams, and DefaultedHttpParams.

◆ removeParameter()

boolean removeParameter ( String  name)
Parameters
nameparameter name
Returns
true if the parameter existed and has been removed, false else.

Implemented in ClientParamsStack, BasicHttpParams, and DefaultedHttpParams.

◆ getLongParameter()

long getLongParameter ( String  name,
long  defaultValue 
)

If the parameter is not explicitly set, the default value is returned.

Parameters
namethe parent name.
defaultValuethe default value.
Returns
a Long that represents the value of the parameter.
See also
setLongParameter(String, long)

Implemented in AbstractHttpParams.

◆ setLongParameter()

HttpParams setLongParameter ( String  name,
long  value 
)
Parameters
nameparameter name
valueparameter value

Implemented in AbstractHttpParams.

◆ getIntParameter()

int getIntParameter ( String  name,
int  defaultValue 
)

If the parameter is not explicitly set, the default value is returned.

Parameters
namethe parent name.
defaultValuethe default value.
Returns
a Integer that represents the value of the parameter.
See also
setIntParameter(String, int)

Implemented in AbstractHttpParams.

◆ setIntParameter()

HttpParams setIntParameter ( String  name,
int  value 
)
Parameters
nameparameter name
valueparameter value

Implemented in AbstractHttpParams.

◆ getDoubleParameter()

double getDoubleParameter ( String  name,
double  defaultValue 
)

If the parameter is not explicitly set, the default value is returned.

Parameters
namethe parent name.
defaultValuethe default value.
Returns
a Double that represents the value of the parameter.
See also
setDoubleParameter(String, double)

Implemented in AbstractHttpParams.

◆ setDoubleParameter()

HttpParams setDoubleParameter ( String  name,
double  value 
)
Parameters
nameparameter name
valueparameter value

Implemented in AbstractHttpParams.

◆ getBooleanParameter()

boolean getBooleanParameter ( String  name,
boolean  defaultValue 
)

If the parameter is not explicitly set, the default value is returned.

Parameters
namethe parent name.
defaultValuethe default value.
Returns
a Boolean that represents the value of the parameter.
See also
setBooleanParameter(String, boolean)

Implemented in AbstractHttpParams.

◆ setBooleanParameter()

HttpParams setBooleanParameter ( String  name,
boolean  value 
)
Parameters
nameparameter name
valueparameter value

Implemented in AbstractHttpParams.

◆ isParameterTrue()

boolean isParameterTrue ( String  name)
Parameters
nameparameter name
Returns
true if the parameter is set to value true, false if it is not set or set to false

Implemented in AbstractHttpParams.

◆ isParameterFalse()

boolean isParameterFalse ( String  name)
Parameters
nameparameter name
Returns
true if the parameter is either not set or set to value false, false if it is set to true

Implemented in AbstractHttpParams.