• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
AbstractHttpParams Class Referenceabstract

Abstract base class for parameter collections. More...

Inheritance diagram for AbstractHttpParams:
HttpParams ClientParamsStack BasicHttpParams DefaultedHttpParams

Description

Type specific setters and getters are mapped to the abstract, generic getters and setters.

Author
Oleg Kalnichevski
Roland Weber
Version
Revision
542224

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

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...
 
- Public Member Functions inherited from HttpParams
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...
 

Protected Member Functions

 AbstractHttpParams ()
 Instantiates parameters.
 

Member Function Documentation

◆ getLongParameter()

long getLongParameter ( final 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)

Implements HttpParams.

◆ setLongParameter()

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

Implements HttpParams.

◆ getIntParameter()

int getIntParameter ( final 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)

Implements HttpParams.

◆ setIntParameter()

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

Implements HttpParams.

◆ getDoubleParameter()

double getDoubleParameter ( final 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)

Implements HttpParams.

◆ setDoubleParameter()

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

Implements HttpParams.

◆ getBooleanParameter()

boolean getBooleanParameter ( final 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)

Implements HttpParams.

◆ setBooleanParameter()

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

Implements HttpParams.

◆ isParameterTrue()

boolean isParameterTrue ( final 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

Implements HttpParams.

◆ isParameterFalse()

boolean isParameterFalse ( final 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

Implements HttpParams.