Added in API level 1
Deprecated in API level 22

HttpParams

interface HttpParams
org.apache.http.params.HttpParams

Represents a collection of HTTP protocol and framework parameters.

Summary

Public methods
abstract HttpParams!

Creates a copy of these parameters.

abstract Boolean
getBooleanParameter(name: String!, defaultValue: Boolean)

Returns a Boolean parameter value with the given name.

abstract Double
getDoubleParameter(name: String!, defaultValue: Double)

Returns a Double parameter value with the given name.

abstract Int
getIntParameter(name: String!, defaultValue: Int)

Returns an Integer parameter value with the given name.

abstract Long
getLongParameter(name: String!, defaultValue: Long)

Returns a Long parameter value with the given name.

abstract Any!

Obtains the value of the given parameter.

abstract Boolean

Checks if a boolean parameter is not set or false.

abstract Boolean

Checks if a boolean parameter is set to true.

abstract Boolean

Removes the parameter with the specified name.

abstract HttpParams!

Assigns a Boolean to the parameter with the given name

abstract HttpParams!
setDoubleParameter(name: String!, value: Double)

Assigns a Double to the parameter with the given name

abstract HttpParams!
setIntParameter(name: String!, value: Int)

Assigns an Integer to the parameter with the given name

abstract HttpParams!
setLongParameter(name: String!, value: Long)

Assigns a Long to the parameter with the given name

abstract HttpParams!
setParameter(name: String!, value: Any!)

Assigns the value to the parameter with the given name.

Public methods

copy

Added in API level 1
abstract fun copy(): HttpParams!

Deprecated: Deprecated in Java.

Creates a copy of these parameters.

Return
HttpParams! a new set of parameters holding the same values as this one

getBooleanParameter

Added in API level 1
abstract fun getBooleanParameter(
    name: String!,
    defaultValue: Boolean
): Boolean

Deprecated: Deprecated in Java.

Returns a Boolean parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

Parameters
name String!: the parent name.
defaultValue Boolean: the default value.
Return
Boolean a Boolean that represents the value of the parameter.

getDoubleParameter

Added in API level 1
abstract fun getDoubleParameter(
    name: String!,
    defaultValue: Double
): Double

Deprecated: Deprecated in Java.

Returns a Double parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

Parameters
name String!: the parent name.
defaultValue Double: the default value.
Return
Double a Double that represents the value of the parameter.

getIntParameter

Added in API level 1
abstract fun getIntParameter(
    name: String!,
    defaultValue: Int
): Int

Deprecated: Deprecated in Java.

Returns an Integer parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

Parameters
name String!: the parent name.
defaultValue Int: the default value.
Return
Int a Integer that represents the value of the parameter.

getLongParameter

Added in API level 1
abstract fun getLongParameter(
    name: String!,
    defaultValue: Long
): Long

Deprecated: Deprecated in Java.

Returns a Long parameter value with the given name. If the parameter is not explicitly set, the default value is returned.

Parameters
name String!: the parent name.
defaultValue Long: the default value.
Return
Long a Long that represents the value of the parameter.

getParameter

Added in API level 1
abstract fun getParameter(name: String!): Any!

Deprecated: Deprecated in Java.

Obtains the value of the given parameter.

Parameters
name String!: the parent name.
Return
Any! an object that represents the value of the parameter, null if the parameter is not set or if it is explicitly set to null

isParameterFalse

Added in API level 1
abstract fun isParameterFalse(name: String!): Boolean

Deprecated: Deprecated in Java.

Checks if a boolean parameter is not set or false.

Parameters
name String!: parameter name
Return
Boolean true if the parameter is either not set or set to value false, false if it is set to true

isParameterTrue

Added in API level 1
abstract fun isParameterTrue(name: String!): Boolean

Deprecated: Deprecated in Java.

Checks if a boolean parameter is set to true.

Parameters
name String!: parameter name
Return
Boolean true if the parameter is set to value true, false if it is not set or set to false

removeParameter

Added in API level 1
abstract fun removeParameter(name: String!): Boolean

Deprecated: Deprecated in Java.

Removes the parameter with the specified name.

Parameters
name String!: parameter name
Return
Boolean true if the parameter existed and has been removed, false else.

setBooleanParameter

Added in API level 1
abstract fun setBooleanParameter(
    name: String!,
    value: Boolean
): HttpParams!

Deprecated: Deprecated in Java.

Assigns a Boolean to the parameter with the given name

Parameters
name String!: parameter name
value Boolean: parameter value

setDoubleParameter

Added in API level 1
abstract fun setDoubleParameter(
    name: String!,
    value: Double
): HttpParams!

Deprecated: Deprecated in Java.

Assigns a Double to the parameter with the given name

Parameters
name String!: parameter name
value Double: parameter value

setIntParameter

Added in API level 1
abstract fun setIntParameter(
    name: String!,
    value: Int
): HttpParams!

Deprecated: Deprecated in Java.

Assigns an Integer to the parameter with the given name

Parameters
name String!: parameter name
value Int: parameter value

setLongParameter

Added in API level 1
abstract fun setLongParameter(
    name: String!,
    value: Long
): HttpParams!

Deprecated: Deprecated in Java.

Assigns a Long to the parameter with the given name

Parameters
name String!: parameter name
value Long: parameter value

setParameter

Added in API level 1
abstract fun setParameter(
    name: String!,
    value: Any!
): HttpParams!

Deprecated: Deprecated in Java.

Assigns the value to the parameter with the given name.

Parameters
name String!: parameter name
value Any!: parameter value