Interface HttpParams
- All Known Implementing Classes:
DefaultHttpParams
,HostParams
,HttpClientParams
,HttpConnectionManagerParams
,HttpConnectionParams
,HttpMethodParams
public interface HttpParams
This interface represents a collection of HTTP protocol parameters. 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.
- Since:
- 3.0
- Version:
- $Revision: 480424 $
-
Method Summary
Modifier and TypeMethodDescriptionboolean
getBooleanParameter
(String name, boolean defaultValue) Returns aBoolean
parameter value with the given name.Returns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itselfdouble
getDoubleParameter
(String name, double defaultValue) Returns aDouble
parameter value with the given name.int
getIntParameter
(String name, int defaultValue) Returns anInteger
parameter value with the given name.long
getLongParameter
(String name, long defaultValue) Returns aLong
parameter value with the given name.getParameter
(String name) Returns a parameter value with the given name.boolean
isParameterFalse
(String name) Returns true if the parameter is either not set or is false, false otherwise.boolean
isParameterSet
(String name) Returns true if the parameter is set at any level, false otherwise.boolean
isParameterSetLocally
(String name) Returns true if the parameter is set locally, false otherwise.boolean
isParameterTrue
(String name) Returns true if the parameter is set and is true, false otherwise.void
setBooleanParameter
(String name, boolean value) Assigns aBoolean
to the parameter with the given namevoid
setDefaults
(HttpParams params) Assigns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itselfvoid
setDoubleParameter
(String name, double value) Assigns aDouble
to the parameter with the given namevoid
setIntParameter
(String name, int value) Assigns anInteger
to the parameter with the given namevoid
setLongParameter
(String name, long value) Assigns aLong
to the parameter with the given namevoid
setParameter
(String name, Object value) Assigns the value to the parameter with the given name
-
Method Details
-
getDefaults
HttpParams getDefaults()Returns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itself- Returns:
- the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.
- See Also:
-
setDefaults
Assigns the parent collection that this collection will defer to for a default value if a particular parameter is not explicitly set in the collection itself- Parameters:
params
- the parent collection to defer to, if a particular parameter is not explictly set in the collection itself.- See Also:
-
getParameter
Returns a parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, null value is returned.- Parameters:
name
- the parent name.- Returns:
- an object that represents the value of the parameter.
- See Also:
-
setParameter
Assigns the value to the parameter with the given name- Parameters:
name
- parameter namevalue
- parameter value
-
getLongParameter
Returns aLong
parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.- Parameters:
name
- the parent name.defaultValue
- the default value.- Returns:
- a
Long
that represents the value of the parameter. - See Also:
-
setLongParameter
Assigns aLong
to the parameter with the given name- Parameters:
name
- parameter namevalue
- parameter value
-
getIntParameter
Returns anInteger
parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.- Parameters:
name
- the parent name.defaultValue
- the default value.- Returns:
- a
Integer
that represents the value of the parameter. - See Also:
-
setIntParameter
Assigns anInteger
to the parameter with the given name- Parameters:
name
- parameter namevalue
- parameter value
-
getDoubleParameter
Returns aDouble
parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.- Parameters:
name
- the parent name.defaultValue
- the default value.- Returns:
- a
Double
that represents the value of the parameter. - See Also:
-
setDoubleParameter
Assigns aDouble
to the parameter with the given name- Parameters:
name
- parameter namevalue
- parameter value
-
getBooleanParameter
Returns aBoolean
parameter value with the given name. If the parameter is not explicitly defined in this collection, its value will be drawn from a higer level collection at which this parameter is defined. If the parameter is not explicitly set anywhere up the hierarchy, the default value is returned.- Parameters:
name
- the parent name.defaultValue
- the default value.- Returns:
- a
Boolean
that represents the value of the parameter. - See Also:
-
setBooleanParameter
Assigns aBoolean
to the parameter with the given name- Parameters:
name
- parameter namevalue
- parameter value
-
isParameterSet
Returns true if the parameter is set at any level, false otherwise.- Parameters:
name
- parameter name- Returns:
- true if the parameter is set at any level, false otherwise.
-
isParameterSetLocally
Returns true if the parameter is set locally, false otherwise.- Parameters:
name
- parameter name- Returns:
- true if the parameter is set locally, false otherwise.
-
isParameterTrue
Returns true if the parameter is set and is true, false otherwise.- Parameters:
name
- parameter name- Returns:
- true if the parameter is set and is true, false otherwise.
-
isParameterFalse
Returns true if the parameter is either not set or is false, false otherwise.- Parameters:
name
- parameter name- Returns:
- true if the parameter is either not set or is false, false otherwise.
-