HttpParams
interfaceHttpParams
org.apache.http.params.HttpParams |
Represents a collection of HTTP protocol and framework parameters.
Summary
Public methods | |
---|---|
abstract HttpParams! |
copy() Creates a copy of these parameters. |
abstract Boolean |
getBooleanParameter(name: String!, defaultValue: Boolean) Returns a |
abstract Double |
getDoubleParameter(name: String!, defaultValue: Double) Returns a |
abstract Int |
getIntParameter(name: String!, defaultValue: Int) Returns an |
abstract Long |
getLongParameter(name: String!, defaultValue: Long) Returns a |
abstract Any! |
getParameter(name: String!) Obtains the value of the given parameter. |
abstract Boolean |
isParameterFalse(name: String!) Checks if a boolean parameter is not set or |
abstract Boolean |
isParameterTrue(name: String!) Checks if a boolean parameter is set to |
abstract Boolean |
removeParameter(name: String!) Removes the parameter with the specified name. |
abstract HttpParams! |
setBooleanParameter(name: String!, value: Boolean) Assigns a |
abstract HttpParams! |
setDoubleParameter(name: String!, value: Double) Assigns a |
abstract HttpParams! |
setIntParameter(name: String!, value: Int) Assigns an |
abstract HttpParams! |
setLongParameter(name: String!, value: Long) Assigns a |
abstract HttpParams! |
setParameter(name: String!, value: Any!) Assigns the value to the parameter with the given name. |
Public methods
copy
abstract funcopy(): 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
abstract fungetBooleanParameter(
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
abstract fungetDoubleParameter(
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. |
See Also
getIntParameter
abstract fungetIntParameter(
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. |
See Also
getLongParameter
abstract fungetLongParameter(
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. |
See Also
getParameter
abstract fungetParameter(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 |
See Also
isParameterFalse
abstract funisParameterFalse(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
abstract funisParameterTrue(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
abstract funremoveParameter(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
abstract funsetBooleanParameter(
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
abstract funsetDoubleParameter(
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
abstract funsetIntParameter(
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
abstract funsetLongParameter(
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
abstract funsetParameter(
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 |